mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-08-03 13:00:54 +08:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 OpenRouter SDK Bot
|
5ab44f08f0 |
+14
-2
@@ -1,13 +1,25 @@
|
|||||||
.venv/
|
|
||||||
venv/
|
venv/
|
||||||
src/*.egg-info/
|
src/*.egg-info/
|
||||||
**/__pycache__/
|
**/__pycache__/
|
||||||
.pytest_cache/
|
.pytest_cache/
|
||||||
.python-version
|
.python-version
|
||||||
.DS_Store
|
|
||||||
pyrightconfig.json
|
pyrightconfig.json
|
||||||
**/.speakeasy/temp/
|
**/.speakeasy/temp/
|
||||||
**/.speakeasy/logs/
|
**/.speakeasy/logs/
|
||||||
.speakeasy/reports
|
.speakeasy/reports
|
||||||
|
# Build artifacts
|
||||||
|
/dist
|
||||||
|
__pycache__/
|
||||||
|
*.py[cod]
|
||||||
|
*.egg-info/
|
||||||
|
*.egg
|
||||||
|
# Speakeasy generation artifacts (generated in OSS repo, not here)
|
||||||
|
.speakeasy/*.lock
|
||||||
|
.speakeasy/*.openapi.yaml
|
||||||
|
/docs
|
||||||
|
# Environment
|
||||||
.env
|
.env
|
||||||
.env.local
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
.DS_Store
|
||||||
|
.venv/
|
||||||
|
|||||||
+5465
-1065
File diff suppressed because it is too large
Load Diff
+4
-1
@@ -25,13 +25,14 @@ generation:
|
|||||||
schemas:
|
schemas:
|
||||||
allOfMergeStrategy: shallowMerge
|
allOfMergeStrategy: shallowMerge
|
||||||
requestBodyFieldName: ""
|
requestBodyFieldName: ""
|
||||||
|
persistentEdits: {}
|
||||||
tests:
|
tests:
|
||||||
generateTests: false
|
generateTests: false
|
||||||
generateNewTests: true
|
generateNewTests: true
|
||||||
skipResponseBodyAssertions: false
|
skipResponseBodyAssertions: false
|
||||||
preApplyUnionDiscriminators: true
|
preApplyUnionDiscriminators: true
|
||||||
python:
|
python:
|
||||||
version: 0.7.12
|
version: 0.8.0
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dev: {}
|
dev: {}
|
||||||
main: {}
|
main: {}
|
||||||
@@ -46,6 +47,7 @@ python:
|
|||||||
- OpenRouter
|
- OpenRouter
|
||||||
baseErrorName: OpenRouterError
|
baseErrorName: OpenRouterError
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
constFieldCasing: upper
|
||||||
defaultErrorName: OpenRouterDefaultError
|
defaultErrorName: OpenRouterDefaultError
|
||||||
description: Official Python Client SDK for OpenRouter.
|
description: Official Python Client SDK for OpenRouter.
|
||||||
enableCustomCodeRegions: false
|
enableCustomCodeRegions: false
|
||||||
@@ -77,6 +79,7 @@ python:
|
|||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageManager: uv
|
packageManager: uv
|
||||||
packageName: openrouter
|
packageName: openrouter
|
||||||
|
preApplyUnionDiscriminators: false
|
||||||
pytestFilterWarnings: []
|
pytestFilterWarnings: []
|
||||||
pytestTimeout: 0
|
pytestTimeout: 0
|
||||||
responseFormat: flat
|
responseFormat: flat
|
||||||
|
|||||||
+2206
-653
File diff suppressed because it is too large
Load Diff
+2206
-656
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.666.0
|
speakeasyVersion: 1.680.0
|
||||||
sources:
|
sources:
|
||||||
-OAS:
|
-OAS:
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
@@ -8,23 +8,22 @@ sources:
|
|||||||
- latest
|
- latest
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
sourceRevisionDigest: sha256:6b805ea430a51e0e4d11cd3b3165f9ff26b37973a0bba53ecc126f990d5fb707
|
sourceRevisionDigest: sha256:c6e52cd6931f7230cd3c226f7482b02dc0dfd682cd14540deb6f721fc0fe9d83
|
||||||
sourceBlobDigest: sha256:65e20830b3e0a412d17017ce0c6c15a31e6069a7b273da22ea3880502725930e
|
sourceBlobDigest: sha256:01ccba21dd9b8695a4071a9f75c329c4c57fdc2c8dfc0ee189ddb2e5ea1dfecb
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- main
|
|
||||||
- 1.0.0
|
- 1.0.0
|
||||||
targets:
|
targets:
|
||||||
open-router:
|
open-router:
|
||||||
source: OpenRouter API
|
source: OpenRouter API
|
||||||
sourceNamespace: open-router-chat-completions-api
|
sourceNamespace: open-router-chat-completions-api
|
||||||
sourceRevisionDigest: sha256:6b805ea430a51e0e4d11cd3b3165f9ff26b37973a0bba53ecc126f990d5fb707
|
sourceRevisionDigest: sha256:c6e52cd6931f7230cd3c226f7482b02dc0dfd682cd14540deb6f721fc0fe9d83
|
||||||
sourceBlobDigest: sha256:65e20830b3e0a412d17017ce0c6c15a31e6069a7b273da22ea3880502725930e
|
sourceBlobDigest: sha256:01ccba21dd9b8695a4071a9f75c329c4c57fdc2c8dfc0ee189ddb2e5ea1dfecb
|
||||||
codeSamplesNamespace: open-router-python-code-samples
|
codeSamplesNamespace: open-router-python-code-samples
|
||||||
codeSamplesRevisionDigest: sha256:44bca5099ff33e05a3f4e5acf8f83f48dc1d84efc8758381a528abcc871bc874
|
codeSamplesRevisionDigest: sha256:1a98221b7ae69cb68277c44cbbaac0c80b5260821b687848445bbc6dddc26894
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: 1.666.0
|
speakeasyVersion: 1.680.0
|
||||||
sources:
|
sources:
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
inputs:
|
inputs:
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: 1.666.0
|
speakeasyVersion: 1.680.0
|
||||||
sources:
|
sources:
|
||||||
OpenRouter API:
|
OpenRouter API:
|
||||||
inputs:
|
inputs:
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# AllowedTools
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Always
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -5,14 +5,13 @@ Assistant message for requests and responses
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
| `role` | [components.AssistantMessageRole](../components/assistantmessagerole.md) | :heavy_check_mark: | N/A | |
|
| `role` | [components.AssistantMessageRole](../components/assistantmessagerole.md) | :heavy_check_mark: | N/A | |
|
||||||
| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | |
|
| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | |
|
||||||
| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | |
|
| `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 | |
|
| `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 | |
|
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message if content was refused | |
|
||||||
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | |
|
| `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 | |
|
| `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/>] |
|
| `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/>} |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# Background
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| `TRANSPARENT` | transparent |
|
|
||||||
| `OPAQUE` | opaque |
|
|
||||||
| `AUTO` | auto |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -20,7 +20,7 @@ Chat completion request parameters
|
|||||||
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false |
|
| `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 |
|
| `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_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). Note: some providers enforce a minimum of 16. | 100 |
|
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens) | 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/>} |
|
| `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 |
|
| `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/>} |
|
| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | Configuration options for reasoning models | {<br/>"effort": "medium",<br/>"summary": "concise"<br/>} |
|
||||||
@@ -36,5 +36,4 @@ Chat completion request parameters
|
|||||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 |
|
| `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/>} |
|
| `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/>} |
|
| `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", "image", and "audio". | [<br/>"text",<br/>"image"<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/>] |
|
||||||
| `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. | |
|
|
||||||
@@ -10,4 +10,3 @@ The provider sorting strategy (price, throughput, latency)
|
|||||||
| `PRICE` | price |
|
| `PRICE` | price |
|
||||||
| `THROUGHPUT` | throughput |
|
| `THROUGHPUT` | throughput |
|
||||||
| `LATENCY` | latency |
|
| `LATENCY` | latency |
|
||||||
| `EXACTO` | exacto |
|
|
||||||
@@ -3,12 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description |
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||||
| `id` | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md) | :heavy_check_mark: | N/A | |
|
| `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. | |
|
| `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 | |
|
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||||
| `search_prompt` | *Optional[str]* | :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. | |
|
| `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/>] |
|
|
||||||
@@ -10,4 +10,3 @@ The provider sorting strategy (price, throughput, latency)
|
|||||||
| `PRICE` | price |
|
| `PRICE` | price |
|
||||||
| `THROUGHPUT` | throughput |
|
| `THROUGHPUT` | throughput |
|
||||||
| `LATENCY` | latency |
|
| `LATENCY` | latency |
|
||||||
| `EXACTO` | exacto |
|
|
||||||
@@ -8,4 +8,3 @@
|
|||||||
| `PRICE` | price |
|
| `PRICE` | price |
|
||||||
| `THROUGHPUT` | throughput |
|
| `THROUGHPUT` | throughput |
|
||||||
| `LATENCY` | latency |
|
| `LATENCY` | latency |
|
||||||
| `EXACTO` | exacto |
|
|
||||||
@@ -8,4 +8,3 @@
|
|||||||
| `PRICE` | price |
|
| `PRICE` | price |
|
||||||
| `THROUGHPUT` | throughput |
|
| `THROUGHPUT` | throughput |
|
||||||
| `LATENCY` | latency |
|
| `LATENCY` | latency |
|
||||||
| `EXACTO` | exacto |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ChatGenerationParamsType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `EPHEMERAL` | ephemeral |
|
|
||||||
@@ -29,9 +29,3 @@ value: components.ChatMessageContentItemAudio = /* values here */
|
|||||||
value: components.ChatMessageContentItem1 = /* values here */
|
value: components.ChatMessageContentItem1 = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `components.ChatMessageContentItemFile`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ChatMessageContentItemFile = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Cache control for the content part
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
| `type` | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md) | :heavy_check_mark: | N/A |
|
| `type` | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md) | :heavy_check_mark: | N/A |
|
||||||
| `ttl` | [Optional[components.ChatMessageContentItemCacheControlTTL]](../components/chatmessagecontentitemcachecontrolttl.md) | :heavy_minus_sign: | N/A |
|
| `ttl` | [Optional[components.TTL]](../components/ttl.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ChatMessageContentItemCacheControlTTL
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------- | ------- |
|
|
||||||
| `FIVEM` | 5m |
|
|
||||||
| `ONEH` | 1h |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ChatMessageContentItemFileType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `FILE` | file |
|
|
||||||
@@ -8,4 +8,4 @@ Log probabilities for the completion
|
|||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
| `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for content tokens |
|
| `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for content tokens |
|
||||||
| `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_minus_sign: | Log probabilities for refusal tokens |
|
| `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for refusal tokens |
|
||||||
@@ -12,5 +12,5 @@ Chat completion response
|
|||||||
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
|
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
|
||||||
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
|
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
|
||||||
| `object` | [components.ChatResponseObject](../components/chatresponseobject.md) | :heavy_check_mark: | N/A | |
|
| `object` | [components.ChatResponseObject](../components/chatresponseobject.md) | :heavy_check_mark: | N/A | |
|
||||||
| `system_fingerprint` | *Nullable[str]* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb |
|
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | 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/>} |
|
| `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/>} |
|
||||||
@@ -5,12 +5,11 @@ Delta changes in streaming response
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
| `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | The role of the message author | assistant |
|
| `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 |
|
| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | Message content delta | Hello |
|
||||||
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to |
|
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to |
|
||||||
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | <nil> |
|
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | <nil> |
|
||||||
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls delta | |
|
| `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 | |
|
| `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/>} |
|
|
||||||
@@ -12,6 +12,6 @@ Streaming chat completion chunk
|
|||||||
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
|
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
|
||||||
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
|
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
|
||||||
| `object` | [components.ChatStreamingResponseChunkObject](../components/chatstreamingresponsechunkobject.md) | :heavy_check_mark: | N/A | |
|
| `object` | [components.ChatStreamingResponseChunkObject](../components/chatstreamingresponsechunkobject.md) | :heavy_check_mark: | N/A | |
|
||||||
| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb |
|
| `system_fingerprint` | *OptionalNullable[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/>} |
|
| `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/>} |
|
| `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/>} |
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# CompoundFilterType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----- | ----- |
|
|
||||||
| `AND` | and |
|
|
||||||
| `OR` | or |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# Container
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.ContainerAuto`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ContainerAuto = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# ContainerType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `AUTO` | auto |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# Environment
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `WINDOWS` | windows |
|
|
||||||
| `MAC` | mac |
|
|
||||||
| `LINUX` | linux |
|
|
||||||
| `UBUNTU` | ubuntu |
|
|
||||||
| `BROWSER` | browser |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# FiltersType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----- | ----- |
|
|
||||||
| `EQ` | eq |
|
|
||||||
| `NE` | ne |
|
|
||||||
| `GT` | gt |
|
|
||||||
| `GTE` | gte |
|
|
||||||
| `LT` | lt |
|
|
||||||
| `LTE` | lte |
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# Format
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.FormatText`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.FormatText = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.FormatGrammar`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.FormatGrammar = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# FormatText
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
||||||
| `type` | [components.FormatTypeText](../components/formattypetext.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# FormatTypeGrammar
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `GRAMMAR` | grammar |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# FormatTypeText
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `TEXT` | text |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# InputFidelity
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `HIGH` | high |
|
|
||||||
| `LOW` | low |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# InputImageMask
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
| `file_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# ResponseOutputTextLogprob
|
# Logprob
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# MemoryLimit
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| `ONEG` | 1g |
|
|
||||||
| `FOURG` | 4g |
|
|
||||||
| `SIXTEENG` | 16g |
|
|
||||||
| `SIXTY_FOURG` | 64g |
|
|
||||||
@@ -20,4 +20,5 @@ Information about an AI model available on OpenRouter
|
|||||||
| `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/>} |
|
| `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 | |
|
| `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/>"top_k": 0,<br/>"frequency_penalty": 0,<br/>"presence_penalty": 0,<br/>"repetition_penalty": 1<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/>} |
|
||||||
|
| `knowledge_cutoff` | *OptionalNullable[str]* | :heavy_minus_sign: | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 |
|
||||||
| `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 |
|
| `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 |
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# ModelEnum
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------------ | ------------------ |
|
|
||||||
| `GPT_IMAGE_1` | gpt-image-1 |
|
|
||||||
| `GPT_IMAGE_1_MINI` | gpt-image-1-mini |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# Moderation
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `AUTO` | auto |
|
|
||||||
| `LOW` | low |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# Never
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
| `type` | [components.OpenAIResponsesInputTypeFunctionCallOutput](../components/openairesponsesinputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | |
|
| `type` | [components.OpenAIResponsesInputTypeFunctionCallOutput](../components/openairesponsesinputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | |
|
||||||
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
|
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
|
||||||
| `call_id` | *str* | :heavy_check_mark: | N/A | |
|
| `call_id` | *str* | :heavy_check_mark: | N/A | |
|
||||||
| `output` | [components.OpenAIResponsesInputOutput2](../components/openairesponsesinputoutput2.md) | :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 |
|
| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed |
|
||||||
@@ -3,9 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
| `type` | [Optional[components.OpenAIResponsesInputTypeMessage1]](../components/openairesponsesinputtypemessage1.md) | :heavy_minus_sign: | N/A |
|
| `type` | [Optional[components.OpenAIResponsesInputTypeMessage1]](../components/openairesponsesinputtypemessage1.md) | :heavy_minus_sign: | N/A |
|
||||||
| `role` | [components.OpenAIResponsesInputRoleUnion1](../components/openairesponsesinputroleunion1.md) | :heavy_check_mark: | N/A |
|
| `role` | [components.OpenAIResponsesInputRoleUnion1](../components/openairesponsesinputroleunion1.md) | :heavy_check_mark: | N/A |
|
||||||
| `content` | [components.OpenAIResponsesInputContent2](../components/openairesponsesinputcontent2.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 |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# OpenAIResponsesInputOutput2
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `List[components.OpenAIResponsesInputOutput1]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[components.OpenAIResponsesInputOutput1] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenAIResponsesInputPhaseCommentary
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `COMMENTARY` | commentary |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenAIResponsesInputPhaseFinalAnswer
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------- | -------------- |
|
|
||||||
| `FINAL_ANSWER` | final_answer |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# OpenResponsesApplyPatchTool
|
|
||||||
|
|
||||||
Apply patch tool configuration
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | [components.OpenResponsesApplyPatchToolType](../components/openresponsesapplypatchtooltype.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesApplyPatchToolType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| `APPLY_PATCH` | apply_patch |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesComputerToolType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------------- | ---------------------- |
|
|
||||||
| `COMPUTER_USE_PREVIEW` | computer_use_preview |
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -3,9 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `type` | [Optional[components.OpenResponsesEasyInputMessageTypeMessage]](../components/openresponseseasyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A | |
|
| `type` | [Optional[components.OpenResponsesEasyInputMessageTypeMessage]](../components/openresponseseasyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A |
|
||||||
| `role` | [components.OpenResponsesEasyInputMessageRoleUnion](../components/openresponseseasyinputmessageroleunion.md) | :heavy_check_mark: | 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 | |
|
| `content` | [components.OpenResponsesEasyInputMessageContentUnion2](../components/openresponseseasyinputmessagecontentunion2.md) | :heavy_check_mark: | 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 |
|
|
||||||
@@ -15,9 +15,3 @@ value: List[components.OpenResponsesEasyInputMessageContentUnion1] = /* values h
|
|||||||
value: str = /* values here */
|
value: str = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `Any`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: Any = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesEasyInputMessagePhaseCommentary
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `COMMENTARY` | commentary |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesEasyInputMessagePhaseFinalAnswer
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------- | -------------- |
|
|
||||||
| `FINAL_ANSWER` | final_answer |
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -5,10 +5,10 @@ The output from a function call execution
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
| `type` | [components.OpenResponsesFunctionCallOutputTypeFunctionCallOutput](../components/openresponsesfunctioncalloutputtypefunctioncalloutput.md) | :heavy_check_mark: | N/A | |
|
| `type` | [components.OpenResponsesFunctionCallOutputType](../components/openresponsesfunctioncalloutputtype.md) | :heavy_check_mark: | N/A | |
|
||||||
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
|
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
|
||||||
| `call_id` | *str* | :heavy_check_mark: | N/A | |
|
| `call_id` | *str* | :heavy_check_mark: | N/A | |
|
||||||
| `output` | [components.OpenResponsesFunctionCallOutputOutputUnion2](../components/openresponsesfunctioncalloutputoutputunion2.md) | :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 |
|
| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# OpenResponsesFunctionCallOutputDetail
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------ | ------ |
|
|
||||||
| `AUTO` | auto |
|
|
||||||
| `HIGH` | high |
|
|
||||||
| `LOW` | low |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# OpenResponsesFunctionCallOutputOutputUnion2
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `str`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: str = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `List[components.OpenResponsesFunctionCallOutputOutputUnion1]`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: List[components.OpenResponsesFunctionCallOutputOutputUnion1] = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesFunctionCallOutputTypeFunctionCallOutput
|
# OpenResponsesFunctionCallOutputType
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# OpenResponsesFunctionShellTool
|
|
||||||
|
|
||||||
Shell tool configuration
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | [components.OpenResponsesFunctionShellToolType](../components/openresponsesfunctionshelltooltype.md) | :heavy_check_mark: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesFunctionShellToolType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------- | ------- |
|
|
||||||
| `SHELL` | shell |
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesImageGenerationToolType
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------------ | ------------------ |
|
|
||||||
| `IMAGE_GENERATION` | image_generation |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesInputUnion
|
# OpenResponsesInput
|
||||||
|
|
||||||
Input for a response request - can be a string or array of items
|
Input for a response request - can be a string or array of items
|
||||||
|
|
||||||
@@ -11,9 +11,9 @@ Input for a response request - can be a string or array of items
|
|||||||
value: str = /* values here */
|
value: str = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `List[components.OpenResponsesInputUnion1]`
|
### `List[components.OpenResponsesInput1]`
|
||||||
|
|
||||||
```python
|
```python
|
||||||
value: List[components.OpenResponsesInputUnion1] = /* values here */
|
value: List[components.OpenResponsesInput1] = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
+5
-5
@@ -1,4 +1,4 @@
|
|||||||
# OpenResponsesInputUnion1
|
# OpenResponsesInput1
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
@@ -33,16 +33,16 @@ value: components.OpenResponsesFunctionToolCall = /* values here */
|
|||||||
value: components.OpenResponsesFunctionCallOutput = /* values here */
|
value: components.OpenResponsesFunctionCallOutput = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `components.OpenResponsesInputMessage`
|
### `components.ResponsesOutputMessage`
|
||||||
|
|
||||||
```python
|
```python
|
||||||
value: components.OpenResponsesInputMessage = /* values here */
|
value: components.ResponsesOutputMessage = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `components.OpenResponsesInputReasoning`
|
### `components.ResponsesOutputItemReasoning`
|
||||||
|
|
||||||
```python
|
```python
|
||||||
value: components.OpenResponsesInputReasoning = /* values here */
|
value: components.ResponsesOutputItemReasoning = /* values here */
|
||||||
```
|
```
|
||||||
|
|
||||||
### `components.ResponsesOutputItemFunctionCall`
|
### `components.ResponsesOutputItemFunctionCall`
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# OpenResponsesInputContent1
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
|
||||||
|
|
||||||
### `components.ResponseOutputText`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.ResponseOutputText = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
### `components.OpenAIResponsesRefusalContent`
|
|
||||||
|
|
||||||
```python
|
|
||||||
value: components.OpenAIResponsesRefusalContent = /* values here */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# 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. |
|
|
||||||
@@ -8,4 +8,4 @@
|
|||||||
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
| `type` | [Optional[components.OpenResponsesInputMessageItemTypeMessage]](../components/openresponsesinputmessageitemtypemessage.md) | :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 |
|
| `role` | [components.OpenResponsesInputMessageItemRoleUnion](../components/openresponsesinputmessageitemroleunion.md) | :heavy_check_mark: | N/A |
|
||||||
| `content` | List[[components.OpenResponsesInputMessageItemContentUnion](../components/openresponsesinputmessageitemcontentunion.md)] | :heavy_minus_sign: | N/A |
|
| `content` | List[[components.OpenResponsesInputMessageItemContentUnion](../components/openresponsesinputmessageitemcontentunion.md)] | :heavy_check_mark: | N/A |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesInputPhaseCommentary
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `COMMENTARY` | commentary |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesInputPhaseFinalAnswer
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------- | -------------- |
|
|
||||||
| `FINAL_ANSWER` | final_answer |
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# 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 */
|
|
||||||
```
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesInputRole
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `ASSISTANT` | assistant |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesInputStatusCompleted1
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `COMPLETED` | completed |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesInputStatusCompleted2
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| `COMPLETED` | completed |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# OpenResponsesInputStatusIncomplete1
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `INCOMPLETE` | incomplete |
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user