wassname/openrouter-python-sdk-retry-errors
1
0
Fork 0
mirror of https://github.com/wassname/openrouter-python-sdk-retry-errors.git synced 2026-08-01 12:40:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Commits included in this export:

Browse Source 
- 35d4e3137846cf3e0a5800e012692818f0dfe309
  - b2f10545419cea6b8a12c509f41ec4bd3937af0c
  - 2dbb7d9612a6e699caa91f334ad105dbde6442ee
  - 50539a3577b5a7e925b756f6bb87744052701215
  - 2cdbe64441ce4435ea0a1ff9127472e815fdaccf
  - f35bb49a8b788937fa61c0cf4591b14f2bc8b217
  - 08a37babde9ad8df5e24e0cd865d3292b1627464
  - 7ddc8e1ed230ca489bc11a5e14696c209ea76349
  - ad31290f38f3f02627f3e1953f1d7cf3e06159a5
  - fb7f764b500618e322f56d49997fbcfaebba7e39
  - 4306c032b9b4f3cfefeacdd3d243b0336f3b2f15

GitOrigin-RevId: 35d4e3137846cf3e0a5800e012692818f0dfe309
This commit is contained in:
OpenRouter Team
2026-03-17 02:59:58 +00:00
parent e72a84e82d
commit 13d706e274
433 changed files with 18149 additions and 2124 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/components/action.md
+23
View File
@@ -0,0 +1,23 @@
# Action
## Supported Types
### `components.ActionSearch`
```python
value: components.ActionSearch = /* values here */
```
### `components.ActionOpenPage`
```python
value: components.ActionOpenPage = /* values here */
```
### `components.ActionFindInPage`
```python
value: components.ActionFindInPage = /* values here */
```
docs/components/actionfindinpage.md
+10
View File
@@ -0,0 +1,10 @@
# ActionFindInPage
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `type` | [components.TypeFindInPage](../components/typefindinpage.md) | :heavy_check_mark: | N/A |
| `pattern` | *str* | :heavy_check_mark: | N/A |
| `url` | *str* | :heavy_check_mark: | N/A |
docs/components/actionopenpage.md
+9
View File
@@ -0,0 +1,9 @@
# ActionOpenPage
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| `type` | [components.TypeOpenPage](../components/typeopenpage.md) | :heavy_check_mark: | N/A |
| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
docs/components/actionsearch.md
+11
View File
@@ -0,0 +1,11 @@
# ActionSearch
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `type` | [components.TypeSearch](../components/typesearch.md) | :heavy_check_mark: | N/A |
| `query` | *str* | :heavy_check_mark: | N/A |
| `queries` | List[*str*] | :heavy_minus_sign: | N/A |
| `sources` | List[[components.Source](../components/source.md)] | :heavy_minus_sign: | N/A |
docs/components/allowedtools.md
+9
View File
@@ -0,0 +1,9 @@
# AllowedTools
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A |
docs/components/always.md
+8
View File
@@ -0,0 +1,8 @@
# Always
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
docs/components/assistantmessage.md
+11 -10
View File
@@ -5,13 +5,14 @@ Assistant message for requests and responses
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `role` | [components.AssistantMessageRole](../components/assistantmessagerole.md) | :heavy_check_mark: | N/A | |
| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | |
| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | |
| `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls made by the assistant | |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message if content was refused | |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | |
| `images` | List[[components.AssistantMessageImages](../components/assistantmessageimages.md)] | :heavy_minus_sign: | Generated images from image generation models | [<br/>{<br/>"image_url": {<br/>"url": "data:image/png;base64,iVBORw0KGgo..."<br/>}<br/>}<br/>] |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `role` | [components.AssistantMessageRole](../components/assistantmessagerole.md) | :heavy_check_mark: | N/A | |
| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | |
| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | |
| `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls made by the assistant | |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message if content was refused | |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | |
| `images` | List[[components.AssistantMessageImages](../components/assistantmessageimages.md)] | :heavy_minus_sign: | Generated images from image generation models | [<br/>{<br/>"image_url": {<br/>"url": "data:image/png;base64,iVBORw0KGgo..."<br/>}<br/>}<br/>] |
| `audio` | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md) | :heavy_minus_sign: | Audio output data or reference | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |
docs/components/background.md
+10
View File
@@ -0,0 +1,10 @@
# Background
## Values
| Name | Value |
| ------------- | ------------- |
| `TRANSPARENT` | transparent |
| `OPAQUE` | opaque |
| `AUTO` | auto |
docs/components/by.md
+2 -1
View File
@@ -9,4 +9,5 @@ The provider sorting strategy (price, throughput, latency)
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `LATENCY` | latency |
| `EXACTO` | exacto |
docs/components/cachecontrol.md
+11
View File
@@ -0,0 +1,11 @@
# CacheControl
Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `type` | [components.ChatGenerationParamsType](../components/chatgenerationparamstype.md) | :heavy_check_mark: | N/A |
| `ttl` | [Optional[components.ChatGenerationParamsTTL]](../components/chatgenerationparamsttl.md) | :heavy_minus_sign: | N/A |
docs/components/chatcompletionaudiooutput.md
+13
View File
@@ -0,0 +1,13 @@
# ChatCompletionAudioOutput
Audio output data or reference
## Fields
| Field | Type | Required | Description |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `id` | *Optional[str]* | :heavy_minus_sign: | Audio output identifier |
| `expires_at` | *Optional[float]* | :heavy_minus_sign: | Audio expiration timestamp |
| `data` | *Optional[str]* | :heavy_minus_sign: | Base64 encoded audio data |
| `transcript` | *Optional[str]* | :heavy_minus_sign: | Audio transcript |
docs/components/chatgenerationparams.md
+3 -2
View File
@@ -20,7 +20,7 @@ Chat completion request parameters
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false |
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 |
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens in completion | 100 |
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens) | 100 |
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 |
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | {<br/>"user_id": "user-123",<br/>"session_id": "session-456"<br/>} |
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 |
| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | Configuration options for reasoning models | {<br/>"effort": "medium",<br/>"summary": "concise"<br/>} |
@@ -36,4 +36,5 @@ Chat completion request parameters
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 |
| `debug` | [Optional[components.DebugOptions]](../components/debugoptions.md) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | {<br/>"echo_upstream_body": true<br/>} |
| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | {<br/>"aspect_ratio": "16:9"<br/>} |
| `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [<br/>"text",<br/>"image"<br/>] |
| `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [<br/>"text",<br/>"image"<br/>] |
| `cache_control` | [Optional[components.CacheControl]](../components/cachecontrol.md) | :heavy_minus_sign: | Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. | |
docs/components/chatgenerationparamsby.md
+2 -1
View File
@@ -9,4 +9,5 @@ The provider sorting strategy (price, throughput, latency)
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `LATENCY` | latency |
| `EXACTO` | exacto |
docs/components/chatgenerationparamsidcontextcompression.md
+8
View File
@@ -0,0 +1,8 @@
# ChatGenerationParamsIDContextCompression
## Values
| Name | Value |
| --------------------- | --------------------- |
| `CONTEXT_COMPRESSION` | context-compression |
docs/components/chatgenerationparamsplugincontextcompression.md
+10
View File
@@ -0,0 +1,10 @@
# ChatGenerationParamsPluginContextCompression
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `id` | [components.ChatGenerationParamsIDContextCompression](../components/chatgenerationparamsidcontextcompression.md) | :heavy_check_mark: | N/A |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. |
| `engine` | [Optional[components.ContextCompressionEngine]](../components/contextcompressionengine.md) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". |
docs/components/chatgenerationparamspluginunion.md
+6
View File
@@ -33,3 +33,9 @@ value: components.ChatGenerationParamsPluginFileParser = /* values here */
value: components.ChatGenerationParamsPluginResponseHealing = /* values here */
```
### `components.ChatGenerationParamsPluginContextCompression`
```python
value: components.ChatGenerationParamsPluginContextCompression = /* values here */
```
docs/components/chatgenerationparamspluginweb.md
+9 -7
View File
@@ -3,10 +3,12 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `id` | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md) | :heavy_check_mark: | N/A |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. |
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.md) | :heavy_minus_sign: | The search engine to use for web search. |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md) | :heavy_check_mark: | N/A | |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | |
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A | |
| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.md) | :heavy_minus_sign: | The search engine to use for web search. | |
| `include_domains` | List[*str*] | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>] |
| `exclude_domains` | List[*str*] | :heavy_minus_sign: | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>] |
docs/components/chatgenerationparamsprovidersort.md
+2 -1
View File
@@ -9,4 +9,5 @@ The provider sorting strategy (price, throughput, latency)
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `LATENCY` | latency |
| `EXACTO` | exacto |
docs/components/chatgenerationparamsprovidersortconfigenum.md
+2 -1
View File
@@ -7,4 +7,5 @@
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `LATENCY` | latency |
| `EXACTO` | exacto |
docs/components/chatgenerationparamssortenum.md
+2 -1
View File
@@ -7,4 +7,5 @@
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `LATENCY` | latency |
| `EXACTO` | exacto |
docs/components/ttl.md → docs/components/chatgenerationparamsttl.md
+1 -1
View File
@@ -1,4 +1,4 @@
# TTL
# ChatGenerationParamsTTL
## Values
docs/components/chatgenerationparamstype.md
+8
View File
@@ -0,0 +1,8 @@
# ChatGenerationParamsType
## Values
| Name | Value |
| ----------- | ----------- |
| `EPHEMERAL` | ephemeral |
docs/components/chatmessagecontentitem.md
+6
View File
@@ -29,3 +29,9 @@ value: components.ChatMessageContentItemAudio = /* values here */
value: components.ChatMessageContentItem1 = /* values here */
```
### `components.ChatMessageContentItemFile`
```python
value: components.ChatMessageContentItemFile = /* values here */
```
docs/components/chatmessagecontentitemcachecontrol.md
+4 -4
View File
@@ -5,7 +5,7 @@ Cache control for the content part
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `type` | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md) | :heavy_check_mark: | N/A |
| `ttl` | [Optional[components.TTL]](../components/ttl.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md) | :heavy_check_mark: | N/A |
| `ttl` | [Optional[components.ChatMessageContentItemCacheControlTTL]](../components/chatmessagecontentitemcachecontrolttl.md) | :heavy_minus_sign: | N/A |
docs/components/chatmessagecontentitemcachecontrolttl.md
+9
View File
@@ -0,0 +1,9 @@
# ChatMessageContentItemCacheControlTTL
## Values
| Name | Value |
| ------- | ------- |
| `FIVEM` | 5m |
| `ONEH` | 1h |
docs/components/chatmessagecontentitemfile.md
+11
View File
@@ -0,0 +1,11 @@
# ChatMessageContentItemFile
File content part for document processing
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemFileType](../components/chatmessagecontentitemfiletype.md) | :heavy_check_mark: | N/A |
| `file` | [components.File](../components/file.md) | :heavy_check_mark: | N/A |
docs/components/chatmessagecontentitemfiletype.md
+8
View File
@@ -0,0 +1,8 @@
# ChatMessageContentItemFileType
## Values
| Name | Value |
| ------ | ------ |
| `FILE` | file |
docs/components/chatmessagetokenlogprobs.md
+1 -1
View File
@@ -8,4 +8,4 @@ Log probabilities for the completion
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for content tokens |
| `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for refusal tokens |
| `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_minus_sign: | Log probabilities for refusal tokens |
docs/components/chatresponse.md
+1 -1
View File
@@ -12,5 +12,5 @@ Chat completion response
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
| `object` | [components.ChatResponseObject](../components/chatresponseobject.md) | :heavy_check_mark: | N/A | |
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb |
| `system_fingerprint` | *Nullable[str]* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb |
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} |
docs/components/chatstreamingmessagechunk.md
+9 -8
View File
@@ -5,11 +5,12 @@ Delta changes in streaming response
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | The role of the message author | assistant |
| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | Message content delta | Hello |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | <nil> |
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls delta | |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | The role of the message author | assistant |
| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | Message content delta | Hello |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | <nil> |
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls delta | |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | |
| `audio` | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md) | :heavy_minus_sign: | N/A | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |
docs/components/chatstreamingresponsechunk.md
+1 -1
View File
@@ -12,6 +12,6 @@ Streaming chat completion chunk
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
| `object` | [components.ChatStreamingResponseChunkObject](../components/chatstreamingresponsechunkobject.md) | :heavy_check_mark: | N/A | |
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb |
| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb |
| `error` | [Optional[components.Error]](../components/error.md) | :heavy_minus_sign: | Error information | {<br/>"message": "Rate limit exceeded",<br/>"code": 429<br/>} |
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} |
docs/components/compoundfilter.md
+11
View File
@@ -0,0 +1,11 @@
# CompoundFilter
A compound filter that combines multiple comparison or compound filters
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `type` | [components.CompoundFilterType](../components/compoundfiltertype.md) | :heavy_check_mark: | N/A |
| `filters` | List[Dict[str, *Nullable[Any]*]] | :heavy_check_mark: | N/A |
docs/components/compoundfiltertype.md
+9
View File
@@ -0,0 +1,9 @@
# CompoundFilterType
## Values
| Name | Value |
| ----- | ----- |
| `AND` | and |
| `OR` | or |
docs/components/conflictresponseerrordata.md
+12
View File
@@ -0,0 +1,12 @@
# ConflictResponseErrorData
Error data for ConflictResponse
## Fields
| Field | Type | Required | Description |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `code` | *int* | :heavy_check_mark: | N/A |
| `message` | *str* | :heavy_check_mark: | N/A |
| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A |
docs/components/connectorid.md
+15
View File
@@ -0,0 +1,15 @@
# ConnectorID
## Values
| Name | Value |
| --------------------------- | --------------------------- |
| `CONNECTOR_DROPBOX` | connector_dropbox |
| `CONNECTOR_GMAIL` | connector_gmail |
| `CONNECTOR_GOOGLECALENDAR` | connector_googlecalendar |
| `CONNECTOR_GOOGLEDRIVE` | connector_googledrive |
| `CONNECTOR_MICROSOFTTEAMS` | connector_microsoftteams |
| `CONNECTOR_OUTLOOKCALENDAR` | connector_outlookcalendar |
| `CONNECTOR_OUTLOOKEMAIL` | connector_outlookemail |
| `CONNECTOR_SHAREPOINT` | connector_sharepoint |
docs/components/container.md
+17
View File
@@ -0,0 +1,17 @@
# Container
## Supported Types
### `str`
```python
value: str = /* values here */
```
### `components.ContainerAuto`
```python
value: components.ContainerAuto = /* values here */
```
docs/components/containerauto.md
+10
View File
@@ -0,0 +1,10 @@
# ContainerAuto
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `type` | [components.ContainerType](../components/containertype.md) | :heavy_check_mark: | N/A |
| `file_ids` | List[*str*] | :heavy_minus_sign: | N/A |
| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.md) | :heavy_minus_sign: | N/A |
docs/components/containertype.md
+8
View File
@@ -0,0 +1,8 @@
# ContainerType
## Values
| Name | Value |
| ------ | ------ |
| `AUTO` | auto |
docs/components/contextcompressionengine.md
+10
View File
@@ -0,0 +1,10 @@
# ContextCompressionEngine
The compression engine to use. Defaults to "middle-out".
## Values
| Name | Value |
| ------------ | ------------ |
| `MIDDLE_OUT` | middle-out |
docs/components/datetimeservertool.md
+11
View File
@@ -0,0 +1,11 @@
# DatetimeServerTool
OpenRouter built-in server tool: returns the current date and time
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `type` | [components.DatetimeServerToolType](../components/datetimeservertooltype.md) | :heavy_check_mark: | N/A |
| `parameters` | [Optional[components.DatetimeServerToolParameters]](../components/datetimeservertoolparameters.md) | :heavy_minus_sign: | N/A |
docs/components/datetimeservertoolparameters.md
+8
View File
@@ -0,0 +1,8 @@
# DatetimeServerToolParameters
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `timezone` | *Optional[str]* | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York |
docs/components/datetimeservertooltype.md
+8
View File
@@ -0,0 +1,8 @@
# DatetimeServerToolType
## Values
| Name | Value |
| --------------------- | --------------------- |
| `OPENROUTER_DATETIME` | openrouter:datetime |
docs/components/defaultparameters.md
+4 -1
View File
@@ -9,4 +9,7 @@ Default parameters for this model
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `top_k` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `repetition_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
docs/components/environment.md
+12
View File
@@ -0,0 +1,12 @@
# Environment
## Values
| Name | Value |
| --------- | --------- |
| `WINDOWS` | windows |
| `MAC` | mac |
| `LINUX` | linux |
| `UBUNTU` | ubuntu |
| `BROWSER` | browser |
docs/components/file.md
+10
View File
@@ -0,0 +1,10 @@
# File
## Fields
| Field | Type | Required | Description |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `file_data` | *Optional[str]* | :heavy_minus_sign: | File content as base64 data URL or URL |
| `file_id` | *Optional[str]* | :heavy_minus_sign: | File ID for previously uploaded files |
| `filename` | *Optional[str]* | :heavy_minus_sign: | Original filename |
docs/components/filters.md
+23
View File
@@ -0,0 +1,23 @@
# Filters
## Supported Types
### `components.OpenResponsesFileSearchToolFilters`
```python
value: components.OpenResponsesFileSearchToolFilters = /* values here */
```
### `components.CompoundFilter`
```python
value: components.CompoundFilter = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
docs/components/filterstype.md
+13
View File
@@ -0,0 +1,13 @@
# FiltersType
## Values
| Name | Value |
| ----- | ----- |
| `EQ` | eq |
| `NE` | ne |
| `GT` | gt |
| `GTE` | gte |
| `LT` | lt |
| `LTE` | lte |
docs/components/format_.md
+17
View File
@@ -0,0 +1,17 @@
# Format
## Supported Types
### `components.FormatText`
```python
value: components.FormatText = /* values here */
```
### `components.FormatGrammar`
```python
value: components.FormatGrammar = /* values here */
```
docs/components/formatgrammar.md
+10
View File
@@ -0,0 +1,10 @@
# FormatGrammar
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `type` | [components.FormatTypeGrammar](../components/formattypegrammar.md) | :heavy_check_mark: | N/A |
| `definition` | *str* | :heavy_check_mark: | N/A |
| `syntax` | [components.Syntax](../components/syntax.md) | :heavy_check_mark: | N/A |
docs/components/formattext.md
+8
View File
@@ -0,0 +1,8 @@
# FormatText
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `type` | [components.FormatTypeText](../components/formattypetext.md) | :heavy_check_mark: | N/A |
docs/components/formattypegrammar.md
+8
View File
@@ -0,0 +1,8 @@
# FormatTypeGrammar
## Values
| Name | Value |
| --------- | --------- |
| `GRAMMAR` | grammar |
docs/components/formattypetext.md
+8
View File
@@ -0,0 +1,8 @@
# FormatTypeText
## Values
| Name | Value |
| ------ | ------ |
| `TEXT` | text |
docs/components/inputfidelity.md
+9
View File
@@ -0,0 +1,9 @@
# InputFidelity
## Values
| Name | Value |
| ------ | ------ |
| `HIGH` | high |
| `LOW` | low |
docs/components/inputimagemask.md
+9
View File
@@ -0,0 +1,9 @@
# InputImageMask
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `file_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
docs/components/memorylimit.md
+11
View File
@@ -0,0 +1,11 @@
# MemoryLimit
## Values
| Name | Value |
| ------------- | ------------- |
| `ONEG` | 1g |
| `FOURG` | 4g |
| `SIXTEENG` | 16g |
| `SIXTY_FOURG` | 64g |
docs/components/modality.md
+2 -1
View File
@@ -6,4 +6,5 @@
| Name | Value |
| ------- | ------- |
| `TEXT` | text |
| `IMAGE` | image |
| `IMAGE` | image |
| `AUDIO` | audio |
docs/components/model.md
+1 -1
View File
@@ -19,5 +19,5 @@ Information about an AI model available on OpenRouter
| `top_provider` | [components.TopProviderInfo](../components/topproviderinfo.md) | :heavy_check_mark: | Information about the top provider for this model | {<br/>"context_length": 8192,<br/>"max_completion_tokens": 4096,<br/>"is_moderated": true<br/>} |
| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.md) | :heavy_check_mark: | Per-request token limits | {<br/>"prompt_tokens": 1000,<br/>"completion_tokens": 1000<br/>} |
| `supported_parameters` | List[[components.Parameter](../components/parameter.md)] | :heavy_check_mark: | List of supported parameters for this model | |
| `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :heavy_check_mark: | Default parameters for this model | {<br/>"temperature": 0.7,<br/>"top_p": 0.9,<br/>"frequency_penalty": 0<br/>} |
| `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :heavy_check_mark: | Default parameters for this model | {<br/>"temperature": 0.7,<br/>"top_p": 0.9,<br/>"top_k": 0,<br/>"frequency_penalty": 0,<br/>"presence_penalty": 0,<br/>"repetition_penalty": 1<br/>} |
| `expiration_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 |
docs/components/modelenum.md
+9
View File
@@ -0,0 +1,9 @@
# ModelEnum
## Values
| Name | Value |
| ------------------ | ------------------ |
| `GPT_IMAGE_1` | gpt-image-1 |
| `GPT_IMAGE_1_MINI` | gpt-image-1-mini |
docs/components/moderation.md
+9
View File
@@ -0,0 +1,9 @@
# Moderation
## Values
| Name | Value |
| ------ | ------ |
| `AUTO` | auto |
| `LOW` | low |
docs/components/never.md
+8
View File
@@ -0,0 +1,8 @@
# Never
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
docs/components/openairesponsesinputfunctioncalloutput.md
+1 -1
View File
@@ -8,5 +8,5 @@
| `type` | [components.OpenAIResponsesInputTypeFunctionCallOutput](../components/openairesponsesinputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | |
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `call_id` | *str* | :heavy_check_mark: | N/A | |
| `output` | *str* | :heavy_check_mark: | N/A | |
| `output` | [components.OpenAIResponsesInputOutput2](../components/openairesponsesinputoutput2.md) | :heavy_check_mark: | N/A | |
| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed |
docs/components/openairesponsesinputmessage1.md
+6 -5
View File
@@ -3,8 +3,9 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `type` | [Optional[components.OpenAIResponsesInputTypeMessage1]](../components/openairesponsesinputtypemessage1.md) | :heavy_minus_sign: | N/A |
| `role` | [components.OpenAIResponsesInputRoleUnion1](../components/openairesponsesinputroleunion1.md) | :heavy_check_mark: | N/A |
| `content` | [components.OpenAIResponsesInputContent2](../components/openairesponsesinputcontent2.md) | :heavy_check_mark: | N/A |
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `type` | [Optional[components.OpenAIResponsesInputTypeMessage1]](../components/openairesponsesinputtypemessage1.md) | :heavy_minus_sign: | N/A |
| `role` | [components.OpenAIResponsesInputRoleUnion1](../components/openairesponsesinputroleunion1.md) | :heavy_check_mark: | N/A |
| `content` | [components.OpenAIResponsesInputContent2](../components/openairesponsesinputcontent2.md) | :heavy_check_mark: | N/A |
| `phase` | [OptionalNullable[components.OpenAIResponsesInputPhaseUnion]](../components/openairesponsesinputphaseunion.md) | :heavy_minus_sign: | N/A |
docs/components/openairesponsesinputoutput1.md
+23
View File
@@ -0,0 +1,23 @@
# OpenAIResponsesInputOutput1
## Supported Types
### `components.ResponseInputText`
```python
value: components.ResponseInputText = /* values here */
```
### `components.ResponseInputImage`
```python
value: components.ResponseInputImage = /* values here */
```
### `components.ResponseInputFile`
```python
value: components.ResponseInputFile = /* values here */
```
docs/components/openairesponsesinputoutput2.md
+17
View File
@@ -0,0 +1,17 @@
# OpenAIResponsesInputOutput2
## Supported Types
### `str`
```python
value: str = /* values here */
```
### `List[components.OpenAIResponsesInputOutput1]`
```python
value: List[components.OpenAIResponsesInputOutput1] = /* values here */
```
docs/components/openairesponsesinputphasecommentary.md
+8
View File
@@ -0,0 +1,8 @@
# OpenAIResponsesInputPhaseCommentary
## Values
| Name | Value |
| ------------ | ------------ |
| `COMMENTARY` | commentary |
docs/components/openairesponsesinputphasefinalanswer.md
+8
View File
@@ -0,0 +1,8 @@
# OpenAIResponsesInputPhaseFinalAnswer
## Values
| Name | Value |
| -------------- | -------------- |
| `FINAL_ANSWER` | final_answer |
docs/components/openairesponsesinputphaseunion.md
+23
View File
@@ -0,0 +1,23 @@
# OpenAIResponsesInputPhaseUnion
## Supported Types
### `components.OpenAIResponsesInputPhaseCommentary`
```python
value: components.OpenAIResponsesInputPhaseCommentary = /* values here */
```
### `components.OpenAIResponsesInputPhaseFinalAnswer`
```python
value: components.OpenAIResponsesInputPhaseFinalAnswer = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
docs/components/openresponsesapplypatchtool.md
+10
View File
@@ -0,0 +1,10 @@
# OpenResponsesApplyPatchTool
Apply patch tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `type` | [components.OpenResponsesApplyPatchToolType](../components/openresponsesapplypatchtooltype.md) | :heavy_check_mark: | N/A |
docs/components/openresponsesapplypatchtooltype.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesApplyPatchToolType
## Values
| Name | Value |
| ------------- | ------------- |
| `APPLY_PATCH` | apply_patch |
docs/components/openresponsescodeinterpretertool.md
+11
View File
@@ -0,0 +1,11 @@
# OpenResponsesCodeInterpreterTool
Code interpreter tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `type` | [components.TypeCodeInterpreter](../components/typecodeinterpreter.md) | :heavy_check_mark: | N/A |
| `container` | [components.Container](../components/container.md) | :heavy_check_mark: | N/A |
docs/components/openresponsescomputertool.md
+13
View File
@@ -0,0 +1,13 @@
# OpenResponsesComputerTool
Computer use preview tool configuration
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `type` | [components.OpenResponsesComputerToolType](../components/openresponsescomputertooltype.md) | :heavy_check_mark: | N/A |
| `display_height` | *float* | :heavy_check_mark: | N/A |
| `display_width` | *float* | :heavy_check_mark: | N/A |
| `environment` | [components.Environment](../components/environment.md) | :heavy_check_mark: | N/A |
docs/components/openresponsescomputertooltype.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesComputerToolType
## Values
| Name | Value |
| ---------------------- | ---------------------- |
| `COMPUTER_USE_PREVIEW` | computer_use_preview |
docs/components/openresponsescustomtool.md
+13
View File
@@ -0,0 +1,13 @@
# OpenResponsesCustomTool
Custom tool configuration
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `type` | [components.TypeCustom](../components/typecustom.md) | :heavy_check_mark: | N/A |
| `name` | *str* | :heavy_check_mark: | N/A |
| `description` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `format_` | [Optional[components.Format]](../components/format_.md) | :heavy_minus_sign: | N/A |
docs/components/openresponseseasyinputmessage.md
+6 -5
View File
@@ -3,8 +3,9 @@
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `type` | [Optional[components.OpenResponsesEasyInputMessageTypeMessage]](../components/openresponseseasyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A |
| `role` | [components.OpenResponsesEasyInputMessageRoleUnion](../components/openresponseseasyinputmessageroleunion.md) | :heavy_check_mark: | N/A |
| `content` | [components.OpenResponsesEasyInputMessageContentUnion2](../components/openresponseseasyinputmessagecontentunion2.md) | :heavy_check_mark: | N/A |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [Optional[components.OpenResponsesEasyInputMessageTypeMessage]](../components/openresponseseasyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A | |
| `role` | [components.OpenResponsesEasyInputMessageRoleUnion](../components/openresponseseasyinputmessageroleunion.md) | :heavy_check_mark: | N/A | |
| `content` | [OptionalNullable[components.OpenResponsesEasyInputMessageContentUnion2]](../components/openresponseseasyinputmessagecontentunion2.md) | :heavy_minus_sign: | N/A | |
| `phase` | [OptionalNullable[components.OpenResponsesEasyInputMessagePhaseUnion]](../components/openresponseseasyinputmessagephaseunion.md) | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer |
docs/components/openresponseseasyinputmessagecontentunion2.md
+6
View File
@@ -15,3 +15,9 @@ value: List[components.OpenResponsesEasyInputMessageContentUnion1] = /* values h
value: str = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
docs/components/openresponseseasyinputmessagephasecommentary.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesEasyInputMessagePhaseCommentary
## Values
| Name | Value |
| ------------ | ------------ |
| `COMMENTARY` | commentary |
docs/components/openresponseseasyinputmessagephasefinalanswer.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesEasyInputMessagePhaseFinalAnswer
## Values
| Name | Value |
| -------------- | -------------- |
| `FINAL_ANSWER` | final_answer |
docs/components/openresponseseasyinputmessagephaseunion.md
+25
View File
@@ -0,0 +1,25 @@
# OpenResponsesEasyInputMessagePhaseUnion
The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages.
## Supported Types
### `components.OpenResponsesEasyInputMessagePhaseCommentary`
```python
value: components.OpenResponsesEasyInputMessagePhaseCommentary = /* values here */
```
### `components.OpenResponsesEasyInputMessagePhaseFinalAnswer`
```python
value: components.OpenResponsesEasyInputMessagePhaseFinalAnswer = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
docs/components/openresponsesfilesearchtool.md
+14
View File
@@ -0,0 +1,14 @@
# OpenResponsesFileSearchTool
File search tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `type` | [components.TypeFileSearch](../components/typefilesearch.md) | :heavy_check_mark: | N/A |
| `vector_store_ids` | List[*str*] | :heavy_check_mark: | N/A |
| `filters` | [OptionalNullable[components.Filters]](../components/filters.md) | :heavy_minus_sign: | N/A |
| `max_num_results` | *Optional[int]* | :heavy_minus_sign: | N/A |
| `ranking_options` | [Optional[components.RankingOptions]](../components/rankingoptions.md) | :heavy_minus_sign: | N/A |
docs/components/openresponsesfilesearchtoolfilters.md
+10
View File
@@ -0,0 +1,10 @@
# OpenResponsesFileSearchToolFilters
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `key` | *str* | :heavy_check_mark: | N/A |
| `type` | [components.FiltersType](../components/filterstype.md) | :heavy_check_mark: | N/A |
| `value` | [components.Value2](../components/value2.md) | :heavy_check_mark: | N/A |
docs/components/openresponsesfunctioncalloutput.md
+7 -7
View File
@@ -5,10 +5,10 @@ The output from a function call execution
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `type` | [components.OpenResponsesFunctionCallOutputType](../components/openresponsesfunctioncalloutputtype.md) | :heavy_check_mark: | N/A | |
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `call_id` | *str* | :heavy_check_mark: | N/A | |
| `output` | *str* | :heavy_check_mark: | N/A | |
| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | [components.OpenResponsesFunctionCallOutputTypeFunctionCallOutput](../components/openresponsesfunctioncalloutputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | |
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `call_id` | *str* | :heavy_check_mark: | N/A | |
| `output` | [components.OpenResponsesFunctionCallOutputOutputUnion2](../components/openresponsesfunctioncalloutputoutputunion2.md) | :heavy_check_mark: | N/A | |
| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed |
docs/components/openresponsesfunctioncalloutputdetail.md
+10
View File
@@ -0,0 +1,10 @@
# OpenResponsesFunctionCallOutputDetail
## Values
| Name | Value |
| ------ | ------ |
| `AUTO` | auto |
| `HIGH` | high |
| `LOW` | low |
docs/components/openresponsesfunctioncalloutputoutputunion1.md
+23
View File
@@ -0,0 +1,23 @@
# OpenResponsesFunctionCallOutputOutputUnion1
## Supported Types
### `components.ResponseInputText`
```python
value: components.ResponseInputText = /* values here */
```
### `components.OutputInputImage`
```python
value: components.OutputInputImage = /* values here */
```
### `components.ResponseInputFile`
```python
value: components.ResponseInputFile = /* values here */
```
docs/components/openresponsesfunctioncalloutputoutputunion2.md
+17
View File
@@ -0,0 +1,17 @@
# OpenResponsesFunctionCallOutputOutputUnion2
## Supported Types
### `str`
```python
value: str = /* values here */
```
### `List[components.OpenResponsesFunctionCallOutputOutputUnion1]`
```python
value: List[components.OpenResponsesFunctionCallOutputOutputUnion1] = /* values here */
```
docs/components/openresponsesfunctioncalloutputtype.md → docs/components/openresponsesfunctioncalloutputtypefunctioncalloutput.md
+1 -1
View File
@@ -1,4 +1,4 @@
# OpenResponsesFunctionCallOutputType
# OpenResponsesFunctionCallOutputTypeFunctionCallOutput
## Values
docs/components/openresponsesfunctionshelltool.md
+10
View File
@@ -0,0 +1,10 @@
# OpenResponsesFunctionShellTool
Shell tool configuration
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `type` | [components.OpenResponsesFunctionShellToolType](../components/openresponsesfunctionshelltooltype.md) | :heavy_check_mark: | N/A |
docs/components/openresponsesfunctionshelltooltype.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesFunctionShellToolType
## Values
| Name | Value |
| ------- | ------- |
| `SHELL` | shell |
docs/components/openresponsesimagegenerationtool.md
+20
View File
@@ -0,0 +1,20 @@
# OpenResponsesImageGenerationTool
Image generation tool configuration
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `type` | [components.OpenResponsesImageGenerationToolType](../components/openresponsesimagegenerationtooltype.md) | :heavy_check_mark: | N/A |
| `background` | [Optional[components.Background]](../components/background.md) | :heavy_minus_sign: | N/A |
| `input_fidelity` | [OptionalNullable[components.InputFidelity]](../components/inputfidelity.md) | :heavy_minus_sign: | N/A |
| `input_image_mask` | [Optional[components.InputImageMask]](../components/inputimagemask.md) | :heavy_minus_sign: | N/A |
| `model` | [Optional[components.ModelEnum]](../components/modelenum.md) | :heavy_minus_sign: | N/A |
| `moderation` | [Optional[components.Moderation]](../components/moderation.md) | :heavy_minus_sign: | N/A |
| `output_compression` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `output_format` | [Optional[components.OutputFormat]](../components/outputformat.md) | :heavy_minus_sign: | N/A |
| `partial_images` | *Optional[float]* | :heavy_minus_sign: | N/A |
| `quality` | [Optional[components.Quality]](../components/quality.md) | :heavy_minus_sign: | N/A |
| `size` | [Optional[components.Size]](../components/size.md) | :heavy_minus_sign: | N/A |
docs/components/openresponsesimagegenerationtooltype.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesImageGenerationToolType
## Values
| Name | Value |
| ------------------ | ------------------ |
| `IMAGE_GENERATION` | image_generation |
docs/components/openresponsesinputcontent1.md
+17
View File
@@ -0,0 +1,17 @@
# OpenResponsesInputContent1
## Supported Types
### `components.ResponseOutputText`
```python
value: components.ResponseOutputText = /* values here */
```
### `components.OpenAIResponsesRefusalContent`
```python
value: components.OpenAIResponsesRefusalContent = /* values here */
```
docs/components/openresponsesinputcontent2.md
+23
View File
@@ -0,0 +1,23 @@
# OpenResponsesInputContent2
## Supported Types
### `List[components.OpenResponsesInputContent1]`
```python
value: List[components.OpenResponsesInputContent1] = /* values here */
```
### `str`
```python
value: str = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
docs/components/openresponsesinputformat.md
+15
View File
@@ -0,0 +1,15 @@
# OpenResponsesInputFormat
The format of the reasoning content
## Values
| Name | Value |
| --------------------------- | --------------------------- |
| `UNKNOWN` | unknown |
| `OPENAI_RESPONSES_V1` | openai-responses-v1 |
| `AZURE_OPENAI_RESPONSES_V1` | azure-openai-responses-v1 |
| `XAI_RESPONSES_V1` | xai-responses-v1 |
| `ANTHROPIC_CLAUDE_V1` | anthropic-claude-v1 |
| `GOOGLE_GEMINI_V1` | google-gemini-v1 |
docs/components/openresponsesinputmessage.md
+15
View File
@@ -0,0 +1,15 @@
# OpenResponsesInputMessage
An output message item
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | N/A |
| `role` | [components.OpenResponsesInputRole](../components/openresponsesinputrole.md) | :heavy_check_mark: | N/A |
| `type` | [components.OpenResponsesInputTypeMessage](../components/openresponsesinputtypemessage.md) | :heavy_check_mark: | N/A |
| `status` | [Optional[components.OpenResponsesInputStatusUnion1]](../components/openresponsesinputstatusunion1.md) | :heavy_minus_sign: | N/A |
| `content` | [Nullable[components.OpenResponsesInputContent2]](../components/openresponsesinputcontent2.md) | :heavy_check_mark: | N/A |
| `phase` | [OptionalNullable[components.OpenResponsesInputPhaseUnion]](../components/openresponsesinputphaseunion.md) | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. |
docs/components/openresponsesinputmessageitem.md
+1 -1
View File
@@ -8,4 +8,4 @@
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `type` | [Optional[components.OpenResponsesInputMessageItemTypeMessage]](../components/openresponsesinputmessageitemtypemessage.md) | :heavy_minus_sign: | N/A |
| `role` | [components.OpenResponsesInputMessageItemRoleUnion](../components/openresponsesinputmessageitemroleunion.md) | :heavy_check_mark: | N/A |
| `content` | List[[components.OpenResponsesInputMessageItemContentUnion](../components/openresponsesinputmessageitemcontentunion.md)] | :heavy_check_mark: | N/A |
| `content` | List[[components.OpenResponsesInputMessageItemContentUnion](../components/openresponsesinputmessageitemcontentunion.md)] | :heavy_minus_sign: | N/A |
docs/components/openresponsesinputphasecommentary.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesInputPhaseCommentary
## Values
| Name | Value |
| ------------ | ------------ |
| `COMMENTARY` | commentary |
docs/components/openresponsesinputphasefinalanswer.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesInputPhaseFinalAnswer
## Values
| Name | Value |
| -------------- | -------------- |
| `FINAL_ANSWER` | final_answer |
docs/components/openresponsesinputphaseunion.md
+25
View File
@@ -0,0 +1,25 @@
# OpenResponsesInputPhaseUnion
The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages.
## Supported Types
### `components.OpenResponsesInputPhaseCommentary`
```python
value: components.OpenResponsesInputPhaseCommentary = /* values here */
```
### `components.OpenResponsesInputPhaseFinalAnswer`
```python
value: components.OpenResponsesInputPhaseFinalAnswer = /* values here */
```
### `Any`
```python
value: Any = /* values here */
```
docs/components/openresponsesinputreasoning.md
+17
View File
@@ -0,0 +1,17 @@
# OpenResponsesInputReasoning
An output item containing reasoning
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `type` | [components.OpenResponsesInputTypeReasoning](../components/openresponsesinputtypereasoning.md) | :heavy_check_mark: | N/A | |
| `id` | *str* | :heavy_check_mark: | N/A | |
| `content` | List[[components.ReasoningTextContent](../components/reasoningtextcontent.md)] | :heavy_minus_sign: | N/A | |
| `summary` | List[[components.ReasoningSummaryText](../components/reasoningsummarytext.md)] | :heavy_check_mark: | N/A | |
| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
| `status` | [Optional[components.OpenResponsesInputStatusUnion2]](../components/openresponsesinputstatusunion2.md) | :heavy_minus_sign: | N/A | |
| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... |
| `format_` | [OptionalNullable[components.OpenResponsesInputFormat]](../components/openresponsesinputformat.md) | :heavy_minus_sign: | The format of the reasoning content | anthropic-claude-v1 |
docs/components/openresponsesinputrole.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesInputRole
## Values
| Name | Value |
| ----------- | ----------- |
| `ASSISTANT` | assistant |
docs/components/openresponsesinputstatuscompleted1.md
+8
View File
@@ -0,0 +1,8 @@
# OpenResponsesInputStatusCompleted1
## Values
| Name | Value |
| ----------- | ----------- |
| `COMPLETED` | completed |

Some files were not shown because too many files have changed in this diff Show More