From fc4651faf42f541235d751c59d503f41f16ee289 Mon Sep 17 00:00:00 2001 From: Cheng Zhang Date: Fri, 27 Feb 2026 12:52:39 +0000 Subject: [PATCH] typos --- .../reference/rest_api/chat_completion.md | 26 +++++++-------- .../reference/rest_api/headers/index.md | 6 ++-- docs/control/reference/rest_api/messages.md | 22 ++++++------- docs/control/reference/rest_api/responses.md | 32 +++++++++---------- 4 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/control/reference/rest_api/chat_completion.md b/docs/control/reference/rest_api/chat_completion.md index d4f5dd9..1369a3b 100644 --- a/docs/control/reference/rest_api/chat_completion.md +++ b/docs/control/reference/rest_api/chat_completion.md @@ -38,7 +38,7 @@ Messages are distinguished by the `role` field. | Field | Type | Required | Description | |-------|------|----------|-------------| | `role` | `"system"` | Yes | | -| `content` | `string \| array[ContentPartText]` | Yes | The system prompt. | +| `content` | `string | array[ContentPartText]` | Yes | The system prompt. | | `name` | `string` | No | Optional participant name. | #### Developer Message @@ -46,7 +46,7 @@ Messages are distinguished by the `role` field. | Field | Type | Required | Description | |-------|------|----------|-------------| | `role` | `"developer"` | Yes | | -| `content` | `string \| array[ContentPartText]` | Yes | The developer message. | +| `content` | `string | array[ContentPartText]` | Yes | The developer message. | | `name` | `string` | No | Optional participant name. | #### User Message @@ -54,7 +54,7 @@ Messages are distinguished by the `role` field. | Field | Type | Required | Description | |-------|------|----------|-------------| | `role` | `"user"` | Yes | | -| `content` | `string \| array[ContentPart]` | Yes | Supports text, images, audio, and files. See [Content Parts](#content-parts). | +| `content` | `string | array[ContentPart]` | Yes | Supports text, images, audio, and files. See [Content Parts](#content-parts). | | `name` | `string` | No | Optional participant name. | #### Assistant Message @@ -62,7 +62,7 @@ Messages are distinguished by the `role` field. | Field | Type | Required | Description | |-------|------|----------|-------------| | `role` | `"assistant"` | Yes | | -| `content` | `string \| array[ContentPartText \| ContentPartRefusal] \| null` | No | Required unless `tool_calls` is specified. | +| `content` | `string | array[ContentPartText | ContentPartRefusal] | null` | No | Required unless `tool_calls` is specified. | | `name` | `string` | No | Optional participant name. | | `refusal` | `string` | No | Refusal message by the assistant. | | `audio` | `object` | No | Reference to a previous audio response. | @@ -73,7 +73,7 @@ Messages are distinguished by the `role` field. | Field | Type | Required | Description | |-------|------|----------|-------------| | `role` | `"tool"` | Yes | | -| `content` | `string \| array[ContentPartText]` | Yes | The tool result. | +| `content` | `string | array[ContentPartText]` | Yes | The tool result. | | `tool_call_id` | `string` | Yes | ID of the tool call this responds to. | ### Content Parts @@ -115,8 +115,8 @@ User messages support multimodal content: | `model` | `string` | The model used. | | `choices` | `array[Choice]` | Completion choices. | | `usage` | `CompletionUsage` | Token usage statistics. | -| `service_tier` | `string \| null` | Service tier used (e.g., `"auto"`, `"default"`, `"flex"`, `"scale"`, `"priority"`). | -| `system_fingerprint` | `string \| null` | Backend configuration fingerprint. | +| `service_tier` | `string | null` | Service tier used (e.g., `"auto"`, `"default"`, `"flex"`, `"scale"`, `"priority"`). | +| `system_fingerprint` | `string | null` | Backend configuration fingerprint. | ### Choice @@ -125,18 +125,18 @@ User messages support multimodal content: | `index` | `integer` | Index of this choice. | | `message` | `ResponseMessage` | The generated message. | | `finish_reason` | `string` | Why generation stopped: `"stop"`, `"length"`, `"tool_calls"`, `"content_filter"`, `"function_call"`. OpenRouter may also return `"error"`. | -| `logprobs` | `object \| null` | Log probability information, if requested. | +| `logprobs` | `object | null` | Log probability information, if requested. | ### Response Message | Field | Type | Description | |-------|------|-------------| | `role` | `"assistant"` | Always `"assistant"`. | -| `content` | `string \| null` | The message content. | -| `refusal` | `string \| null` | Refusal message, if applicable. | -| `annotations` | `array[Annotation] \| null` | URL citations (e.g. from web search). | -| `audio` | `object \| null` | Audio response data. | -| `tool_calls` | `array[ToolCall] \| null` | Tool calls generated by the model. | +| `content` | `string | null` | The message content. | +| `refusal` | `string | null` | Refusal message, if applicable. | +| `annotations` | `array[Annotation] | null` | URL citations (e.g. from web search). | +| `audio` | `object | null` | Audio response data. | +| `tool_calls` | `array[ToolCall] | null` | Tool calls generated by the model. | ### ToolCall diff --git a/docs/control/reference/rest_api/headers/index.md b/docs/control/reference/rest_api/headers/index.md index 5038f57..816fe5b 100644 --- a/docs/control/reference/rest_api/headers/index.md +++ b/docs/control/reference/rest_api/headers/index.md @@ -7,8 +7,8 @@ The Sequrity Control API supports a set of custom HTTP headers for authenticatio | Header | Required | Description | |--------|----------|-------------| | [`X-Api-Key`](api_key_session_id.md#x-api-key-optional) | No | LLM provider API key (BYOK). If omitted, Sequrity uses its server-managed key. | -| [`X-Session-ID`](api_key_session_id.md#x-session-id-optional) | No | Session identifier for continuing an existing conversation. | -| [`X-Features`](security_features.md) | Required in Headers-Only Mode | JSON object defining the agent architecture and enabled security features (classifiers, blockers). Must be paired with `X-Policy`. | -| [`X-Policy`](security_policy.md) | Required in Headers-Only Mode | JSON object defining security policies and enforcement behavior. Must be paired with `X-Features`. | +| [`X-Session-ID`](api_key_session_id.md#x-session-id-optional) | Not required most of the time (See [Session ID Guide](./api_key_session_id.md#x-session-id-optional)) | Session identifier for continuing an existing conversation. | +| [`X-Features`](security_features.md) | Required in Headers Mode | JSON object defining the agent architecture and enabled security features (classifiers, blockers). Must be paired with `X-Policy`. | +| [`X-Policy`](security_policy.md) | No | JSON object defining security policies and enforcement behavior. Must be paired with `X-Features`. | | [`X-Config`](security_config.md) | No | JSON object for fine-tuning session execution behavior, prompt overrides, and response format settings. | diff --git a/docs/control/reference/rest_api/messages.md b/docs/control/reference/rest_api/messages.md index e798c74..be35ceb 100644 --- a/docs/control/reference/rest_api/messages.md +++ b/docs/control/reference/rest_api/messages.md @@ -20,7 +20,7 @@ Where `{endpoint_type}` is `chat`, `code`, `agent`, or `lang-graph`. See [URL Pa | `messages` | `array[MessageParam]` | Yes | Input messages with alternating `user` and `assistant` turns. See [Messages](#messages). | | `model` | `string` | Yes | Model ID, e.g. `claude-4-sonnet`. For Dual-LLM, specify two models separated by a comma (`pllm,qllm`). | | `max_tokens` | `integer` | Yes | Maximum number of tokens to generate before stopping. | -| `system` | `string \| array[TextBlockParam]` | No | System prompt providing context and instructions. | +| `system` | `string | array[TextBlockParam]` | No | System prompt providing context and instructions. | | `temperature` | `float` | No | Sampling randomness (0.0–1.0). | | `top_p` | `float` | No | Nucleus sampling probability threshold. | | `top_k` | `integer` | No | Only sample from the top K options for each token. | @@ -40,8 +40,8 @@ Each message has a `role` (`"user"` or `"assistant"`) and `content` (a string or | Field | Type | Required | Description | |-------|------|----------|-------------| -| `role` | `"user" \| "assistant"` | Yes | The message author. | -| `content` | `string \| array[ContentBlock]` | Yes | Message content. See [Content Blocks](#content-blocks). | +| `role` | `"user" | "assistant"` | Yes | The message author. | +| `content` | `string | array[ContentBlock]` | Yes | Message content. See [Content Blocks](#content-blocks). | ### Content Blocks @@ -90,7 +90,7 @@ Content blocks are distinguished by the `type` field. |-------|------|----------|-------------| | `type` | `"tool_result"` | Yes | | | `tool_use_id` | `string` | Yes | ID of the tool use this responds to. | -| `content` | `string \| array[TextBlock \| ImageBlock \| DocumentBlock]` | No | The tool result. | +| `content` | `string | array[TextBlock | ImageBlock | DocumentBlock]` | No | The tool result. | | `is_error` | `boolean` | No | `true` if the tool execution errored. | | `cache_control` | `object` | No | Cache control breakpoint. | @@ -149,8 +149,8 @@ Extended thinking configuration. Discriminated by `type`: | `role` | `"assistant"` | Always `"assistant"`. | | `content` | `array[ContentBlock]` | Generated content blocks. See [Response Content Blocks](#response-content-blocks). | | `model` | `string` | The model that handled the request. | -| `stop_reason` | `string \| null` | Why generation stopped: `"end_turn"`, `"max_tokens"`, `"stop_sequence"`, `"tool_use"`, `"pause_turn"`, `"refusal"`. | -| `stop_sequence` | `string \| null` | Which stop sequence was hit, if any. | +| `stop_reason` | `string | null` | Why generation stopped: `"end_turn"`, `"max_tokens"`, `"stop_sequence"`, `"tool_use"`, `"pause_turn"`, `"refusal"`. | +| `stop_sequence` | `string | null` | Which stop sequence was hit, if any. | | `usage` | `Usage` | Token usage statistics. | ### Response Content Blocks @@ -170,11 +170,11 @@ Extended thinking configuration. Discriminated by `type`: |-------|------|-------------| | `input_tokens` | `integer` | Input tokens used. | | `output_tokens` | `integer` | Output tokens generated. | -| `cache_creation_input_tokens` | `integer \| null` | Tokens used to create cache. | -| `cache_read_input_tokens` | `integer \| null` | Tokens read from cache. | -| `cache_creation` | `object \| null` | Breakdown of cached tokens by TTL. | -| `server_tool_use` | `object \| null` | Server tool usage stats. | -| `service_tier` | `string \| null` | `"standard"`, `"priority"`, or `"batch"`. | +| `cache_creation_input_tokens` | `integer | null` | Tokens used to create cache. | +| `cache_read_input_tokens` | `integer | null` | Tokens read from cache. | +| `cache_creation` | `object | null` | Breakdown of cached tokens by TTL. | +| `server_tool_use` | `object | null` | Server tool usage stats. | +| `service_tier` | `string | null` | `"standard"`, `"priority"`, or `"batch"`. | ## Headers diff --git a/docs/control/reference/rest_api/responses.md b/docs/control/reference/rest_api/responses.md index b738919..87892f8 100644 --- a/docs/control/reference/rest_api/responses.md +++ b/docs/control/reference/rest_api/responses.md @@ -19,10 +19,10 @@ Where `{endpoint_type}` is `chat`, `code`, `agent`, or `lang-graph`. See [URL Pa | Field | Type | Required | Description | |-------|------|----------|-------------| | `model` | `string` | Yes | Model ID, e.g. `gpt-4o`, `o3`. | -| `input` | `string \| array[InputItem]` | No | Text, image, or file inputs to the model. See [Input Types](#input-types). | +| `input` | `string | array[InputItem]` | No | Text, image, or file inputs to the model. See [Input Types](#input-types). | | `instructions` | `string` | No | A system (or developer) message inserted into the model's context. | | `tools` | `array[Tool]` | No | Tools the model may call. See [Tools](#tools). | -| `tool_choice` | `string \| object` | No | How the model should select which tool to use: `"none"`, `"auto"`, `"required"`, or a function object. | +| `tool_choice` | `string | object` | No | How the model should select which tool to use: `"none"`, `"auto"`, `"required"`, or a function object. | | `stream` | `boolean` | No | If `true`, the response is streamed as server-sent events. | | `temperature` | `float` | No | Sampling temperature (0–2). Higher values produce more random output. | | `top_p` | `float` | No | Nucleus sampling parameter. | @@ -37,7 +37,7 @@ Where `{endpoint_type}` is `chat`, `code`, `agent`, or `lang-graph`. See [URL Pa | `parallel_tool_calls` | `boolean` | No | Whether to allow parallel tool execution. | | `max_tool_calls` | `integer` | No | Maximum number of calls to built-in tools. | | `background` | `boolean` | No | Whether to run the response in the background. | -| `conversation` | `string \| object` | No | Conversation context. | +| `conversation` | `string | object` | No | Conversation context. | | `prompt` | `object` | No | Prompt template reference with `id` and optional `variables`. | | `service_tier` | `string` | No | Processing tier: `"auto"`, `"default"`, `"flex"`, `"scale"`, `"priority"`. | | `stream_options` | `object` | No | Options for streaming responses (e.g., `include_usage`). | @@ -52,8 +52,8 @@ The `input` field accepts either a plain string or an array of input items. Inpu | Field | Type | Required | Description | |-------|------|----------|-------------| -| `role` | `"user" \| "system" \| "developer"` | Yes | The role of the message. | -| `content` | `string \| array[ContentItem]` | Yes | Message content (text, images, files, or audio). | +| `role` | `"user" | "system" | "developer"` | Yes | The role of the message. | +| `content` | `string | array[ContentItem]` | Yes | Message content (text, images, files, or audio). | #### Content Item Types @@ -126,17 +126,17 @@ The Responses API supports multiple tool types: | `model` | `string` | The model used. | | `output` | `array[OutputItem]` | Generated content items. See [Output Items](#output-items). | | `status` | `string` | Response status: `"completed"`, `"failed"`, `"in_progress"`, `"cancelled"`, `"queued"`, `"incomplete"`. | -| `error` | `object \| null` | Error information with `code` and `message` fields. | +| `error` | `object | null` | Error information with `code` and `message` fields. | | `usage` | `ResponseUsage` | Token usage statistics. | | `parallel_tool_calls` | `boolean` | Whether parallel tool calls were enabled. | -| `tool_choice` | `string \| object` | Tool choice used for this response. | +| `tool_choice` | `string | object` | Tool choice used for this response. | | `tools` | `array[object]` | Tools available for this response. | -| `incomplete_details` | `object \| null` | Details on why the response is incomplete. | -| `temperature` | `float \| null` | Sampling temperature used. | -| `top_p` | `float \| null` | Nucleus sampling used. | -| `max_output_tokens` | `integer \| null` | Max output tokens setting. | -| `truncation` | `string \| null` | Truncation strategy used. | -| `service_tier` | `string \| null` | Service tier used. | +| `incomplete_details` | `object | null` | Details on why the response is incomplete. | +| `temperature` | `float | null` | Sampling temperature used. | +| `top_p` | `float | null` | Nucleus sampling used. | +| `max_output_tokens` | `integer | null` | Max output tokens setting. | +| `truncation` | `string | null` | Truncation strategy used. | +| `service_tier` | `string | null` | Service tier used. | ### Output Items @@ -160,8 +160,8 @@ Output items are distinguished by the `type` field: | `call_id` | `string` | Unique ID for responding with tool output. | | `name` | `string` | The function name. | | `arguments` | `string` | JSON-encoded arguments. | -| `id` | `string \| null` | Unique ID of the tool call. | -| `status` | `string \| null` | `"in_progress"`, `"completed"`, `"incomplete"`. | +| `id` | `string | null` | Unique ID of the tool call. | +| `status` | `string | null` | `"in_progress"`, `"completed"`, `"incomplete"`. | #### Reasoning (`type: "reasoning"`) @@ -170,7 +170,7 @@ Output items are distinguished by the `type` field: | `id` | `string` | Unique ID of the reasoning item. | | `type` | `"reasoning"` | | | `summary` | `array[object]` | Reasoning summary text items. | -| `encrypted_content` | `string \| null` | Encrypted content for multi-turn continuity. | +| `encrypted_content` | `string | null` | Encrypted content for multi-turn continuity. | #### Other Output Item Types