mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-08-01 12:40:23 +08:00
Compare commits
10
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 David Alberto Adler
|
8d26214581 | ||
|
David Alberto Adler
|
d66795f1d4 | ||
|
David Alberto Adler
|
ed17d25183 | ||
|
David Alberto Adler
|
f7f8677367 | ||
|
David Alberto Adler
|
041d7f8bef | ||
|
David Alberto Adler
|
208909274f | ||
|
David Alberto Adler
|
43720ce166 | ||
|
David Alberto Adler
|
7a11b80884 | ||
|
David Alberto Adler
|
03054b21e4 | ||
|
David Alberto Adler
|
da48e8c4ea |
@@ -1,4 +1,9 @@
|
||||
|
||||
<div align="center">
|
||||
<a href="https://codespaces.new/speakeasy-sdks/openrouter-python-sdk.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
|
||||
</div>
|
||||
<br>
|
||||
|
||||
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
||||
|
||||
# Dev Containers Quick Start
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
.env.local
|
||||
.venv/
|
||||
venv/
|
||||
src/*.egg-info/
|
||||
|
||||
+116
-63
@@ -1,39 +1,37 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 03e733ff-14c6-48f8-87a5-37a1a4588594
|
||||
id: 232c6d4f-b0fd-4172-8f1b-e2421566e9b4
|
||||
management:
|
||||
docChecksum: 7849dd264d8d3676743d325682310ed7
|
||||
docChecksum: 98b4f227e767bb91333b3b3469d93fa5
|
||||
docVersion: 1.0.0
|
||||
speakeasyVersion: 1.618.1
|
||||
generationVersion: 2.702.0
|
||||
releaseVersion: 0.1.0
|
||||
configChecksum: 9b2fc6a03dd7103d87270af55bb29a50
|
||||
speakeasyVersion: 1.611.1
|
||||
generationVersion: 2.694.1
|
||||
releaseVersion: 0.5.2
|
||||
configChecksum: 4619605fbeb6f4488feb5336aa62bab6
|
||||
repoURL: https://github.com/speakeasy-sdks/openrouter-python-sdk.git
|
||||
installationURL: https://github.com/speakeasy-sdks/openrouter-python-sdk.git
|
||||
features:
|
||||
python:
|
||||
acceptHeaders: 3.0.0
|
||||
additionalDependencies: 1.0.0
|
||||
constsAndDefaults: 1.0.5
|
||||
core: 5.20.4
|
||||
core: 5.20.3
|
||||
customCodeRegions: 0.1.1
|
||||
defaultEnabledRetries: 0.2.0
|
||||
devContainers: 3.0.0
|
||||
enumUnions: 0.1.0
|
||||
envVarSecurityUsage: 0.3.2
|
||||
flatRequests: 1.0.1
|
||||
globalSecurity: 3.0.4
|
||||
globalSecurity: 3.0.3
|
||||
globalSecurityCallbacks: 1.0.0
|
||||
globalSecurityFlattening: 1.0.0
|
||||
globalServerURLs: 3.1.1
|
||||
groups: 3.0.0
|
||||
methodArguments: 1.0.2
|
||||
nameOverrides: 3.0.1
|
||||
nullables: 1.0.1
|
||||
openEnums: 1.0.1
|
||||
responseFormat: 1.0.1
|
||||
retries: 3.0.2
|
||||
sdkHooks: 1.1.0
|
||||
serverEvents: 1.0.9
|
||||
serverEvents: 1.0.8
|
||||
serverEventsSentinels: 0.1.0
|
||||
serverIDs: 3.0.0
|
||||
unions: 3.0.4
|
||||
generatedFiles:
|
||||
- .devcontainer/README.md
|
||||
@@ -44,7 +42,6 @@ generatedFiles:
|
||||
- USAGE.md
|
||||
- docs/errors/chatcompletionerror.md
|
||||
- docs/models/annotationdetail.md
|
||||
- docs/models/audio.md
|
||||
- docs/models/chatcompletion.md
|
||||
- docs/models/chatcompletionassistantmessageparam.md
|
||||
- docs/models/chatcompletionassistantmessageparamcontent.md
|
||||
@@ -60,7 +57,6 @@ generatedFiles:
|
||||
- docs/models/chatcompletionchunkchoicedeltatoolcalltype.md
|
||||
- docs/models/chatcompletionchunkchoicefinishreason.md
|
||||
- docs/models/chatcompletionchunkobject.md
|
||||
- docs/models/chatcompletionchunkwrapper.md
|
||||
- docs/models/chatcompletioncontentpart.md
|
||||
- docs/models/chatcompletioncontentpartaudio.md
|
||||
- docs/models/chatcompletioncontentpartaudioformat.md
|
||||
@@ -71,6 +67,50 @@ generatedFiles:
|
||||
- docs/models/chatcompletioncontentparttext.md
|
||||
- docs/models/chatcompletioncontentparttexttype.md
|
||||
- docs/models/chatcompletioncreateparams.md
|
||||
- docs/models/chatcompletioncreateparamsaudio.md
|
||||
- docs/models/chatcompletioncreateparamscompletion.md
|
||||
- docs/models/chatcompletioncreateparamsdatacollection.md
|
||||
- docs/models/chatcompletioncreateparamseffort.md
|
||||
- docs/models/chatcompletioncreateparamsengine.md
|
||||
- docs/models/chatcompletioncreateparamsidchainofthought.md
|
||||
- docs/models/chatcompletioncreateparamsidfileparser.md
|
||||
- docs/models/chatcompletioncreateparamsidmoderation.md
|
||||
- docs/models/chatcompletioncreateparamsidweb.md
|
||||
- docs/models/chatcompletioncreateparamsignoreenum.md
|
||||
- docs/models/chatcompletioncreateparamsignoreunion.md
|
||||
- docs/models/chatcompletioncreateparamsimage.md
|
||||
- docs/models/chatcompletioncreateparamsjsonschema.md
|
||||
- docs/models/chatcompletioncreateparamsmaxprice.md
|
||||
- docs/models/chatcompletioncreateparamsonlyenum.md
|
||||
- docs/models/chatcompletioncreateparamsonlyunion.md
|
||||
- docs/models/chatcompletioncreateparamsorderenum.md
|
||||
- docs/models/chatcompletioncreateparamsorderunion.md
|
||||
- docs/models/chatcompletioncreateparamspdf.md
|
||||
- docs/models/chatcompletioncreateparamspdfengine.md
|
||||
- docs/models/chatcompletioncreateparamspluginchainofthought.md
|
||||
- docs/models/chatcompletioncreateparamspluginfileparser.md
|
||||
- docs/models/chatcompletioncreateparamspluginmoderation.md
|
||||
- docs/models/chatcompletioncreateparamspluginunion.md
|
||||
- docs/models/chatcompletioncreateparamspluginweb.md
|
||||
- docs/models/chatcompletioncreateparamsprompt.md
|
||||
- docs/models/chatcompletioncreateparamsprovider.md
|
||||
- docs/models/chatcompletioncreateparamsquantization.md
|
||||
- docs/models/chatcompletioncreateparamsreasoning.md
|
||||
- docs/models/chatcompletioncreateparamsreasoningeffort.md
|
||||
- docs/models/chatcompletioncreateparamsrequest.md
|
||||
- docs/models/chatcompletioncreateparamsresponseformatgrammar.md
|
||||
- docs/models/chatcompletioncreateparamsresponseformatjsonobject.md
|
||||
- docs/models/chatcompletioncreateparamsresponseformatjsonschema.md
|
||||
- docs/models/chatcompletioncreateparamsresponseformatpython.md
|
||||
- docs/models/chatcompletioncreateparamsresponseformattext.md
|
||||
- docs/models/chatcompletioncreateparamsresponseformatunion.md
|
||||
- docs/models/chatcompletioncreateparamssort.md
|
||||
- docs/models/chatcompletioncreateparamsstop.md
|
||||
- docs/models/chatcompletioncreateparamsstreamoptions.md
|
||||
- docs/models/chatcompletioncreateparamstypegrammar.md
|
||||
- docs/models/chatcompletioncreateparamstypejsonobject.md
|
||||
- docs/models/chatcompletioncreateparamstypejsonschema.md
|
||||
- docs/models/chatcompletioncreateparamstypepython.md
|
||||
- docs/models/chatcompletioncreateparamstypetext.md
|
||||
- docs/models/chatcompletionmessage.md
|
||||
- docs/models/chatcompletionmessageparam.md
|
||||
@@ -100,50 +140,67 @@ generatedFiles:
|
||||
- docs/models/chatcompletionusermessageparam.md
|
||||
- docs/models/chatcompletionusermessageparamcontent.md
|
||||
- docs/models/chatcompletionusermessageparamrole.md
|
||||
- docs/models/completion.md
|
||||
- docs/models/chatstreamcompletioncreateparams.md
|
||||
- docs/models/chatstreamcompletioncreateparamsaudio.md
|
||||
- docs/models/chatstreamcompletioncreateparamscompletion.md
|
||||
- docs/models/chatstreamcompletioncreateparamsdatacollection.md
|
||||
- docs/models/chatstreamcompletioncreateparamseffort.md
|
||||
- docs/models/chatstreamcompletioncreateparamsengine.md
|
||||
- docs/models/chatstreamcompletioncreateparamsidchainofthought.md
|
||||
- docs/models/chatstreamcompletioncreateparamsidfileparser.md
|
||||
- docs/models/chatstreamcompletioncreateparamsidmoderation.md
|
||||
- docs/models/chatstreamcompletioncreateparamsidweb.md
|
||||
- docs/models/chatstreamcompletioncreateparamsignoreenum.md
|
||||
- docs/models/chatstreamcompletioncreateparamsignoreunion.md
|
||||
- docs/models/chatstreamcompletioncreateparamsimage.md
|
||||
- docs/models/chatstreamcompletioncreateparamsjsonschema.md
|
||||
- docs/models/chatstreamcompletioncreateparamsmaxprice.md
|
||||
- docs/models/chatstreamcompletioncreateparamsonlyenum.md
|
||||
- docs/models/chatstreamcompletioncreateparamsonlyunion.md
|
||||
- docs/models/chatstreamcompletioncreateparamsorderenum.md
|
||||
- docs/models/chatstreamcompletioncreateparamsorderunion.md
|
||||
- docs/models/chatstreamcompletioncreateparamspdf.md
|
||||
- docs/models/chatstreamcompletioncreateparamspdfengine.md
|
||||
- docs/models/chatstreamcompletioncreateparamspluginchainofthought.md
|
||||
- docs/models/chatstreamcompletioncreateparamspluginfileparser.md
|
||||
- docs/models/chatstreamcompletioncreateparamspluginmoderation.md
|
||||
- docs/models/chatstreamcompletioncreateparamspluginunion.md
|
||||
- docs/models/chatstreamcompletioncreateparamspluginweb.md
|
||||
- docs/models/chatstreamcompletioncreateparamsprompt.md
|
||||
- docs/models/chatstreamcompletioncreateparamsprovider.md
|
||||
- docs/models/chatstreamcompletioncreateparamsquantization.md
|
||||
- docs/models/chatstreamcompletioncreateparamsreasoning.md
|
||||
- docs/models/chatstreamcompletioncreateparamsreasoningeffort.md
|
||||
- docs/models/chatstreamcompletioncreateparamsrequest.md
|
||||
- docs/models/chatstreamcompletioncreateparamsresponseformatgrammar.md
|
||||
- docs/models/chatstreamcompletioncreateparamsresponseformatjsonobject.md
|
||||
- docs/models/chatstreamcompletioncreateparamsresponseformatjsonschema.md
|
||||
- docs/models/chatstreamcompletioncreateparamsresponseformatpython.md
|
||||
- docs/models/chatstreamcompletioncreateparamsresponseformattext.md
|
||||
- docs/models/chatstreamcompletioncreateparamsresponseformatunion.md
|
||||
- docs/models/chatstreamcompletioncreateparamssort.md
|
||||
- docs/models/chatstreamcompletioncreateparamsstop.md
|
||||
- docs/models/chatstreamcompletioncreateparamsstreamoptions.md
|
||||
- docs/models/chatstreamcompletioncreateparamstypegrammar.md
|
||||
- docs/models/chatstreamcompletioncreateparamstypejsonobject.md
|
||||
- docs/models/chatstreamcompletioncreateparamstypejsonschema.md
|
||||
- docs/models/chatstreamcompletioncreateparamstypepython.md
|
||||
- docs/models/chatstreamcompletioncreateparamstypetext.md
|
||||
- docs/models/completiontokensdetails.md
|
||||
- docs/models/completionusage.md
|
||||
- docs/models/contentimageurl.md
|
||||
- docs/models/contenttext.md
|
||||
- docs/models/contenttypeimageurl.md
|
||||
- docs/models/contenttypetext.md
|
||||
- docs/models/createchatcompletionresponse.md
|
||||
- docs/models/datacollection.md
|
||||
- docs/models/detail.md
|
||||
- docs/models/effort.md
|
||||
- docs/models/engine.md
|
||||
- docs/models/error.md
|
||||
- docs/models/file.md
|
||||
- docs/models/fileannotationdetail.md
|
||||
- docs/models/fileannotationdetailcontentunion.md
|
||||
- docs/models/fileannotationdetailimageurl.md
|
||||
- docs/models/idchainofthought.md
|
||||
- docs/models/idfileparser.md
|
||||
- docs/models/idmoderation.md
|
||||
- docs/models/idweb.md
|
||||
- docs/models/ignore.md
|
||||
- docs/models/ignoreenum.md
|
||||
- docs/models/image.md
|
||||
- docs/models/inputaudio.md
|
||||
- docs/models/jsonschema.md
|
||||
- docs/models/maxprice.md
|
||||
- docs/models/only.md
|
||||
- docs/models/onlyenum.md
|
||||
- docs/models/order.md
|
||||
- docs/models/orderenum.md
|
||||
- docs/models/parameters.md
|
||||
- docs/models/pdf.md
|
||||
- docs/models/pdfengine.md
|
||||
- docs/models/plugin.md
|
||||
- docs/models/pluginchainofthought.md
|
||||
- docs/models/pluginfileparser.md
|
||||
- docs/models/pluginmoderation.md
|
||||
- docs/models/pluginweb.md
|
||||
- docs/models/prompt.md
|
||||
- docs/models/prompttokensdetails.md
|
||||
- docs/models/provider.md
|
||||
- docs/models/quantization.md
|
||||
- docs/models/reasoning.md
|
||||
- docs/models/reasoningdetail.md
|
||||
- docs/models/reasoningdetailencrypted.md
|
||||
- docs/models/reasoningdetailencryptedformat.md
|
||||
@@ -154,25 +211,11 @@ generatedFiles:
|
||||
- docs/models/reasoningdetailtext.md
|
||||
- docs/models/reasoningdetailtextformat.md
|
||||
- docs/models/reasoningdetailtexttype.md
|
||||
- docs/models/reasoningeffort.md
|
||||
- docs/models/request.md
|
||||
- docs/models/responseformat.md
|
||||
- docs/models/responseformatgrammar.md
|
||||
- docs/models/responseformatjsonobject.md
|
||||
- docs/models/responseformatjsonschema.md
|
||||
- docs/models/responseformatjsonschemaschema.md
|
||||
- docs/models/responseformatpython.md
|
||||
- docs/models/responseformattext.md
|
||||
- docs/models/security.md
|
||||
- docs/models/sort.md
|
||||
- docs/models/stop.md
|
||||
- docs/models/streamoptions.md
|
||||
- docs/models/streamchatcompletionresponsebody.md
|
||||
- docs/models/toplogprob.md
|
||||
- docs/models/typefile.md
|
||||
- docs/models/typegrammar.md
|
||||
- docs/models/typejsonobject.md
|
||||
- docs/models/typejsonschema.md
|
||||
- docs/models/typepython.md
|
||||
- docs/models/urlcitation.md
|
||||
- docs/models/urlcitationannotationdetail.md
|
||||
- docs/models/urlcitationannotationdetailtype.md
|
||||
@@ -182,6 +225,7 @@ generatedFiles:
|
||||
- py.typed
|
||||
- pylintrc
|
||||
- pyproject.toml
|
||||
- scripts/prepare_readme.py
|
||||
- scripts/publish.sh
|
||||
- src/openrouter/__init__.py
|
||||
- src/openrouter/_hooks/__init__.py
|
||||
@@ -206,7 +250,6 @@ generatedFiles:
|
||||
- src/openrouter/models/chatcompletionchunkchoice.py
|
||||
- src/openrouter/models/chatcompletionchunkchoicedelta.py
|
||||
- src/openrouter/models/chatcompletionchunkchoicedeltatoolcall.py
|
||||
- src/openrouter/models/chatcompletionchunkwrapper.py
|
||||
- src/openrouter/models/chatcompletioncontentpart.py
|
||||
- src/openrouter/models/chatcompletioncontentpartaudio.py
|
||||
- src/openrouter/models/chatcompletioncontentpartimage.py
|
||||
@@ -224,8 +267,8 @@ generatedFiles:
|
||||
- src/openrouter/models/chatcompletiontoolchoiceoption.py
|
||||
- src/openrouter/models/chatcompletiontoolmessageparam.py
|
||||
- src/openrouter/models/chatcompletionusermessageparam.py
|
||||
- src/openrouter/models/chatstreamcompletioncreateparams.py
|
||||
- src/openrouter/models/completionusage.py
|
||||
- src/openrouter/models/createchatcompletionop.py
|
||||
- src/openrouter/models/fileannotationdetail.py
|
||||
- src/openrouter/models/reasoningdetail.py
|
||||
- src/openrouter/models/reasoningdetailencrypted.py
|
||||
@@ -233,6 +276,7 @@ generatedFiles:
|
||||
- src/openrouter/models/reasoningdetailtext.py
|
||||
- src/openrouter/models/responseformatjsonschemaschema.py
|
||||
- src/openrouter/models/security.py
|
||||
- src/openrouter/models/streamchatcompletionop.py
|
||||
- src/openrouter/models/urlcitationannotationdetail.py
|
||||
- src/openrouter/py.typed
|
||||
- src/openrouter/sdk.py
|
||||
@@ -265,7 +309,16 @@ examples:
|
||||
"200":
|
||||
application/json: {"id": "<id>", "choices": [], "created": 6977.95, "model": "El Camino", "object": "chat.completion"}
|
||||
"400":
|
||||
application/json: {"error": {"code": 8588.53, "message": "<value>"}}
|
||||
application/json: {"error": {"code": null, "message": "<value>"}}
|
||||
"500":
|
||||
application/json: {"error": {"code": 8588.53, "message": "<value>"}}
|
||||
application/json: {"error": {"code": null, "message": "<value>"}}
|
||||
streamChatCompletion:
|
||||
speakeasy-default-stream-chat-completion:
|
||||
requestBody:
|
||||
application/json: {"messages": [{"role": "user", "content": "Hello, how are you?"}], "stream": true, "temperature": 1, "top_p": 1}
|
||||
responses:
|
||||
"400":
|
||||
application/json: {"error": {"code": null, "message": "<value>"}}
|
||||
"500":
|
||||
application/json: {"error": {"code": null, "message": "<value>"}}
|
||||
examplesVersion: 1.0.2
|
||||
|
||||
+2
-5
@@ -19,15 +19,13 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: true
|
||||
hoistGlobalSecurity: true
|
||||
inferSSEOverload: true
|
||||
sdkHooksConfigAccess: true
|
||||
tests:
|
||||
generateTests: false
|
||||
generateNewTests: true
|
||||
skipResponseBodyAssertions: false
|
||||
python:
|
||||
version: 0.1.0
|
||||
version: 0.5.2
|
||||
additionalDependencies:
|
||||
dev: {}
|
||||
main: {}
|
||||
@@ -39,7 +37,7 @@ python:
|
||||
baseErrorName: OpenRouterError
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: OpenRouterDefaultError
|
||||
description: The OpenRouter Python SDK.
|
||||
description: Python Client SDK Generated by Speakeasy.
|
||||
enableCustomCodeRegions: true
|
||||
enumFormat: union
|
||||
envVarPrefix: OPENROUTER
|
||||
@@ -66,5 +64,4 @@ python:
|
||||
pytestFilterWarnings: []
|
||||
pytestTimeout: 0
|
||||
responseFormat: flat
|
||||
sseFlatResponse: true
|
||||
templateVersion: v2
|
||||
|
||||
+1344
-5818
File diff suppressed because it is too large
Load Diff
+63
-13
@@ -12,7 +12,6 @@ info:
|
||||
url: https://opensource.org/licenses/MIT
|
||||
servers:
|
||||
- url: https://{provider_url}/api/v1
|
||||
x-speakeasy-server-id: production
|
||||
variables:
|
||||
provider_url:
|
||||
default: openrouter.ai
|
||||
@@ -78,7 +77,6 @@ components:
|
||||
type: string
|
||||
nullable: true
|
||||
format:
|
||||
x-speakeasy-unknown-values: allow
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
@@ -105,7 +103,6 @@ components:
|
||||
type: string
|
||||
nullable: true
|
||||
format:
|
||||
x-speakeasy-unknown-values: allow
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
@@ -136,7 +133,6 @@ components:
|
||||
type: string
|
||||
nullable: true
|
||||
format:
|
||||
x-speakeasy-unknown-values: allow
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
@@ -355,7 +351,6 @@ components:
|
||||
type: object
|
||||
properties:
|
||||
finish_reason:
|
||||
x-speakeasy-unknown-values: allow
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
@@ -546,7 +541,6 @@ components:
|
||||
delta:
|
||||
$ref: '#/components/schemas/ChatCompletionChunkChoiceDelta'
|
||||
finish_reason:
|
||||
x-speakeasy-unknown-values: allow
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
@@ -655,7 +649,6 @@ components:
|
||||
type: string
|
||||
description: Base64 encoded audio data
|
||||
format:
|
||||
x-speakeasy-unknown-values: allow
|
||||
type: string
|
||||
enum:
|
||||
- wav
|
||||
@@ -1506,13 +1499,22 @@ components:
|
||||
required:
|
||||
- messages
|
||||
description: Chat completion request parameters
|
||||
ChatStreamCompletionCreateParams:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/ChatCompletionCreateParams'
|
||||
- type: object
|
||||
properties:
|
||||
stream:
|
||||
type: boolean
|
||||
enum:
|
||||
- true
|
||||
default: true
|
||||
description: Enable streaming response
|
||||
parameters: {}
|
||||
paths:
|
||||
/chat/completions:
|
||||
post:
|
||||
operationId: createChatCompletion
|
||||
x-speakeasy-group: chat
|
||||
x-speakeasy-name-override: complete
|
||||
summary: Create a chat completion
|
||||
description: Creates a model response for the given chat conversation. Supports both streaming and non-streaming modes.
|
||||
tags:
|
||||
@@ -1532,10 +1534,6 @@ paths:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatCompletion'
|
||||
description: Non-streaming response when stream=false
|
||||
text/event-stream:
|
||||
x-speakeasy-sse-sentinel: '[DONE]'
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatCompletionChunkWrapper'
|
||||
'400':
|
||||
description: Bad request - invalid parameters
|
||||
content:
|
||||
@@ -1560,3 +1558,55 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatCompletionError'
|
||||
x-speakeasy-name-override: complete
|
||||
/chat/completions#stream:
|
||||
post:
|
||||
operationId: streamChatCompletion
|
||||
summary: Create a chat completion
|
||||
description: Creates a model response for the given chat conversation. Supports both streaming and non-streaming modes.
|
||||
tags:
|
||||
- Chat
|
||||
requestBody:
|
||||
description: Chat completion request parameters
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatStreamCompletionCreateParams'
|
||||
responses:
|
||||
'200':
|
||||
description: Successful chat completion response
|
||||
content:
|
||||
text/event-stream:
|
||||
x-speakeasy-sse-sentinel: '[DONE]'
|
||||
schema:
|
||||
type: object
|
||||
required: [data]
|
||||
properties:
|
||||
data:
|
||||
$ref: '#/components/schemas/ChatCompletionChunk'
|
||||
'400':
|
||||
description: Bad request - invalid parameters
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatCompletionError'
|
||||
'401':
|
||||
description: Unauthorized - invalid API key
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatCompletionError'
|
||||
'429':
|
||||
description: Too many requests - rate limit exceeded
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatCompletionError'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ChatCompletionError'
|
||||
x-speakeasy-name-override: completeStream
|
||||
|
||||
@@ -1,20 +1,19 @@
|
||||
speakeasyVersion: 1.618.1
|
||||
speakeasyVersion: 1.611.1
|
||||
sources:
|
||||
OpenRouter Chat Completions API:
|
||||
sourceNamespace: open-router-chat-completions-api
|
||||
sourceRevisionDigest: sha256:74ae52780983745871d33efc788abba37d1d8b271f358771b180ddb8546d6f7f
|
||||
sourceBlobDigest: sha256:2fd2132e64b77adae1fc045512364d6517f47916c553e757226e5b9012d2170d
|
||||
sourceRevisionDigest: sha256:30b19a8759608792fb4d27f6bf28d5982d7e2a8cf5b3faf34ba3507a62f9f106
|
||||
sourceBlobDigest: sha256:454f1b880a0882a70f78eacccb2c33e3d9d19134a0738b0e21487984a7bf2e63
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1755878373
|
||||
- 1.0.0
|
||||
targets:
|
||||
open-router:
|
||||
source: OpenRouter Chat Completions API
|
||||
sourceNamespace: open-router-chat-completions-api
|
||||
sourceRevisionDigest: sha256:74ae52780983745871d33efc788abba37d1d8b271f358771b180ddb8546d6f7f
|
||||
sourceBlobDigest: sha256:2fd2132e64b77adae1fc045512364d6517f47916c553e757226e5b9012d2170d
|
||||
codeSamplesNamespace: open-router-chat-completions-api-python-code-samples
|
||||
codeSamplesRevisionDigest: sha256:fd8ed35536e452d20ff16d6c33d311ebd405bf7e0f9188cfafcba4cd81539d96
|
||||
sourceRevisionDigest: sha256:30b19a8759608792fb4d27f6bf28d5982d7e2a8cf5b3faf34ba3507a62f9f106
|
||||
sourceBlobDigest: sha256:454f1b880a0882a70f78eacccb2c33e3d9d19134a0738b0e21487984a7bf2e63
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
@@ -24,14 +23,14 @@ workflow:
|
||||
- location: .speakeasy/in.openapi.yaml
|
||||
output: .speakeasy/out.openapi.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
||||
location: registry.speakeasyapi.dev/sheldon-vaughn-test/sandbox/open-router-chat-completions-api
|
||||
targets:
|
||||
open-router:
|
||||
target: python
|
||||
source: OpenRouter Chat Completions API
|
||||
codeSamples:
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api-python-code-samples
|
||||
location: registry.speakeasyapi.dev/sheldon-vaughn-test/sandbox/open-router-chat-completions-api-python-code-samples
|
||||
labelOverride:
|
||||
fixedValue: Python (SDK)
|
||||
blocking: false
|
||||
|
||||
@@ -6,14 +6,14 @@ sources:
|
||||
- location: .speakeasy/in.openapi.yaml
|
||||
output: .speakeasy/out.openapi.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api
|
||||
location: registry.speakeasyapi.dev/sheldon-vaughn-test/sandbox/open-router-chat-completions-api
|
||||
targets:
|
||||
open-router:
|
||||
target: python
|
||||
source: OpenRouter Chat Completions API
|
||||
codeSamples:
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api-python-code-samples
|
||||
location: registry.speakeasyapi.dev/sheldon-vaughn-test/sandbox/open-router-chat-completions-api-python-code-samples
|
||||
labelOverride:
|
||||
fixedValue: Python (SDK)
|
||||
blocking: false
|
||||
|
||||
+19
-34
@@ -140,10 +140,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
```
|
||||
|
||||
</br>
|
||||
@@ -168,10 +166,8 @@ async def main():
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
async with res as event_stream:
|
||||
async for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
@@ -205,10 +201,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
@@ -222,6 +216,7 @@ with OpenRouter(
|
||||
### [chat](https://github.com/speakeasy-sdks/openrouter-python-sdk/blob/master/docs/sdks/chat/README.md)
|
||||
|
||||
* [complete](https://github.com/speakeasy-sdks/openrouter-python-sdk/blob/master/docs/sdks/chat/README.md#complete) - Create a chat completion
|
||||
* [complete_stream](https://github.com/speakeasy-sdks/openrouter-python-sdk/blob/master/docs/sdks/chat/README.md#complete_stream) - Create a chat completion
|
||||
|
||||
|
||||
</details>
|
||||
@@ -248,12 +243,12 @@ with OpenRouter(
|
||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||
) as open_router:
|
||||
|
||||
res = open_router.chat.complete(messages=[
|
||||
res = open_router.chat.complete_stream(messages=[
|
||||
{
|
||||
"role": "user",
|
||||
"content": "Hello, how are you?",
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
], stream=True, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
@@ -291,10 +286,8 @@ with OpenRouter(
|
||||
], stream=False, temperature=1, top_p=1,
|
||||
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
|
||||
@@ -317,10 +310,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
<!-- End Retries [retries] -->
|
||||
@@ -358,10 +349,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
|
||||
except errors.OpenRouterError as e:
|
||||
@@ -428,10 +417,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
|
||||
@@ -455,10 +442,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
@@ -57,7 +57,7 @@ The SDK can be installed with *uv*, *pip*, or *poetry* package managers.
|
||||
*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
|
||||
|
||||
```bash
|
||||
uv add git+<UNSET>.git
|
||||
uv add git+https://github.com/speakeasy-sdks/openrouter-python-sdk.git
|
||||
```
|
||||
|
||||
### PIP
|
||||
@@ -65,7 +65,7 @@ uv add git+<UNSET>.git
|
||||
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
|
||||
|
||||
```bash
|
||||
pip install git+<UNSET>.git
|
||||
pip install git+https://github.com/speakeasy-sdks/openrouter-python-sdk.git
|
||||
```
|
||||
|
||||
### Poetry
|
||||
@@ -73,7 +73,7 @@ pip install git+<UNSET>.git
|
||||
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
|
||||
|
||||
```bash
|
||||
poetry add git+<UNSET>.git
|
||||
poetry add git+https://github.com/speakeasy-sdks/openrouter-python-sdk.git
|
||||
```
|
||||
|
||||
### Shell and script usage with `uv`
|
||||
@@ -140,10 +140,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
```
|
||||
|
||||
</br>
|
||||
@@ -168,10 +166,8 @@ async def main():
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
async with res as event_stream:
|
||||
async for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
@@ -205,10 +201,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
@@ -222,6 +216,7 @@ with OpenRouter(
|
||||
### [chat](docs/sdks/chat/README.md)
|
||||
|
||||
* [complete](docs/sdks/chat/README.md#complete) - Create a chat completion
|
||||
* [complete_stream](docs/sdks/chat/README.md#complete_stream) - Create a chat completion
|
||||
|
||||
|
||||
</details>
|
||||
@@ -248,12 +243,12 @@ with OpenRouter(
|
||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||
) as open_router:
|
||||
|
||||
res = open_router.chat.complete(messages=[
|
||||
res = open_router.chat.complete_stream(messages=[
|
||||
{
|
||||
"role": "user",
|
||||
"content": "Hello, how are you?",
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
], stream=True, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
@@ -291,10 +286,8 @@ with OpenRouter(
|
||||
], stream=False, temperature=1, top_p=1,
|
||||
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
|
||||
@@ -317,10 +310,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
<!-- End Retries [retries] -->
|
||||
@@ -358,10 +349,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
|
||||
except errors.OpenRouterError as e:
|
||||
@@ -401,15 +390,9 @@ with OpenRouter(
|
||||
<!-- Start Server Selection [server] -->
|
||||
## Server Selection
|
||||
|
||||
### Select Server by Name
|
||||
### Server Variables
|
||||
|
||||
You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
|
||||
|
||||
| Name | Server | Variables | Description |
|
||||
| ------------ | ------------------------------- | -------------- | ----------------- |
|
||||
| `production` | `https://{provider_url}/api/v1` | `provider_url` | Production server |
|
||||
|
||||
If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:
|
||||
The default server `https://{provider_url}/api/v1` contains variables and is set to `https://openrouter.ai/api/v1` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||
|
||||
| Variable | Parameter | Default | Description |
|
||||
| -------------- | ------------------- | ----------------- | ----------- |
|
||||
@@ -423,7 +406,6 @@ import os
|
||||
|
||||
|
||||
with OpenRouter(
|
||||
server="production",
|
||||
provider_url="https://ruddy-guacamole.info/"
|
||||
api_key=os.getenv("OPENROUTER_API_KEY", ""),
|
||||
) as open_router:
|
||||
@@ -435,16 +417,14 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
|
||||
The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
|
||||
```python
|
||||
from openrouter import OpenRouter
|
||||
import os
|
||||
@@ -462,10 +442,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
@@ -16,10 +16,8 @@ with OpenRouter(
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
with res as event_stream:
|
||||
for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
```
|
||||
|
||||
</br>
|
||||
@@ -44,10 +42,8 @@ async def main():
|
||||
},
|
||||
], stream=False, temperature=1, top_p=1)
|
||||
|
||||
async with res as event_stream:
|
||||
async for event in event_stream:
|
||||
# handle event
|
||||
print(event, flush=True)
|
||||
# Handle response
|
||||
print(res)
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
@@ -5,30 +5,30 @@ Chat completion request parameters
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `messages` | List[[models.ChatCompletionMessageParam](../models/chatcompletionmessageparam.md)] | :heavy_check_mark: | List of messages for the conversation | [<br/>{<br/>"role": "user",<br/>"content": "Hello, how are you?"<br/>}<br/>] |
|
||||
| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | |
|
||||
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | |
|
||||
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | |
|
||||
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | |
|
||||
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | |
|
||||
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens in completion | |
|
||||
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens) | |
|
||||
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | |
|
||||
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | |
|
||||
| `reasoning` | [OptionalNullable[models.Reasoning]](../models/reasoning.md) | :heavy_minus_sign: | Reasoning configuration | |
|
||||
| `response_format` | [Optional[models.ResponseFormat]](../models/responseformat.md) | :heavy_minus_sign: | Response format configuration | |
|
||||
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | |
|
||||
| `stop` | [OptionalNullable[models.Stop]](../models/stop.md) | :heavy_minus_sign: | Stop sequences (up to 4) | |
|
||||
| `stream` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable streaming response | |
|
||||
| `stream_options` | [OptionalNullable[models.StreamOptions]](../models/streamoptions.md) | :heavy_minus_sign: | N/A | |
|
||||
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | |
|
||||
| `tool_choice` | [Optional[models.ChatCompletionToolChoiceOption]](../models/chatcompletiontoolchoiceoption.md) | :heavy_minus_sign: | Tool choice configuration | |
|
||||
| `tools` | List[[models.ChatCompletionTool](../models/chatcompletiontool.md)] | :heavy_minus_sign: | Available tools for function calling | |
|
||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | |
|
||||
| `user` | *Optional[str]* | :heavy_minus_sign: | Unique user identifier | |
|
||||
| `fallback_models` | List[*str*] | :heavy_minus_sign: | Order of models to fallback to for this request | |
|
||||
| `reasoning_effort` | [OptionalNullable[models.ReasoningEffort]](../models/reasoningeffort.md) | :heavy_minus_sign: | Reasoning effort | |
|
||||
| `provider` | [OptionalNullable[models.Provider]](../models/provider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | |
|
||||
| `plugins` | List[[models.Plugin](../models/plugin.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `messages` | List[[models.ChatCompletionMessageParam](../models/chatcompletionmessageparam.md)] | :heavy_check_mark: | List of messages for the conversation | [<br/>{<br/>"role": "user",<br/>"content": "Hello, how are you?"<br/>}<br/>] |
|
||||
| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | |
|
||||
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | |
|
||||
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | |
|
||||
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | |
|
||||
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | |
|
||||
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens in completion | |
|
||||
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens) | |
|
||||
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | |
|
||||
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | |
|
||||
| `reasoning` | [OptionalNullable[models.ChatCompletionCreateParamsReasoning]](../models/chatcompletioncreateparamsreasoning.md) | :heavy_minus_sign: | Reasoning configuration | |
|
||||
| `response_format` | [Optional[models.ChatCompletionCreateParamsResponseFormatUnion]](../models/chatcompletioncreateparamsresponseformatunion.md) | :heavy_minus_sign: | Response format configuration | |
|
||||
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | |
|
||||
| `stop` | [OptionalNullable[models.ChatCompletionCreateParamsStop]](../models/chatcompletioncreateparamsstop.md) | :heavy_minus_sign: | Stop sequences (up to 4) | |
|
||||
| `stream` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable streaming response | |
|
||||
| `stream_options` | [OptionalNullable[models.ChatCompletionCreateParamsStreamOptions]](../models/chatcompletioncreateparamsstreamoptions.md) | :heavy_minus_sign: | N/A | |
|
||||
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | |
|
||||
| `tool_choice` | [Optional[models.ChatCompletionToolChoiceOption]](../models/chatcompletiontoolchoiceoption.md) | :heavy_minus_sign: | Tool choice configuration | |
|
||||
| `tools` | List[[models.ChatCompletionTool](../models/chatcompletiontool.md)] | :heavy_minus_sign: | Available tools for function calling | |
|
||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | |
|
||||
| `user` | *Optional[str]* | :heavy_minus_sign: | Unique user identifier | |
|
||||
| `fallback_models` | List[*str*] | :heavy_minus_sign: | Order of models to fallback to for this request | |
|
||||
| `reasoning_effort` | [OptionalNullable[models.ChatCompletionCreateParamsReasoningEffort]](../models/chatcompletioncreateparamsreasoningeffort.md) | :heavy_minus_sign: | Reasoning effort | |
|
||||
| `provider` | [OptionalNullable[models.ChatCompletionCreateParamsProvider]](../models/chatcompletioncreateparamsprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | |
|
||||
| `plugins` | List[[models.ChatCompletionCreateParamsPluginUnion](../models/chatcompletioncreateparamspluginunion.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | |
|
||||
@@ -1,4 +1,4 @@
|
||||
# Audio
|
||||
# ChatCompletionCreateParamsAudio
|
||||
|
||||
|
||||
## Supported Types
|
||||
@@ -0,0 +1,23 @@
|
||||
# ChatCompletionCreateParamsCompletion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `float`
|
||||
|
||||
```python
|
||||
value: float = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
### `Any`
|
||||
|
||||
```python
|
||||
value: Any = /* values here */
|
||||
```
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# DataCollection
|
||||
# ChatCompletionCreateParamsDataCollection
|
||||
|
||||
Data collection setting. If no available model provider meets the requirement, your request will return an error.
|
||||
- allow: (default) allow providers which store user data non-transiently and may train on it
|
||||
@@ -1,4 +1,4 @@
|
||||
# Effort
|
||||
# ChatCompletionCreateParamsEffort
|
||||
|
||||
OpenAI-style reasoning effort setting
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Engine
|
||||
# ChatCompletionCreateParamsEngine
|
||||
|
||||
|
||||
## Values
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# IDChainOfThought
|
||||
# ChatCompletionCreateParamsIDChainOfThought
|
||||
|
||||
|
||||
## Values
|
||||
@@ -1,4 +1,4 @@
|
||||
# IDFileParser
|
||||
# ChatCompletionCreateParamsIDFileParser
|
||||
|
||||
|
||||
## Values
|
||||
@@ -1,4 +1,4 @@
|
||||
# IDModeration
|
||||
# ChatCompletionCreateParamsIDModeration
|
||||
|
||||
|
||||
## Values
|
||||
@@ -1,4 +1,4 @@
|
||||
# IDWeb
|
||||
# ChatCompletionCreateParamsIDWeb
|
||||
|
||||
|
||||
## Values
|
||||
@@ -1,4 +1,4 @@
|
||||
# OrderEnum
|
||||
# ChatCompletionCreateParamsIgnoreEnum
|
||||
|
||||
|
||||
## Values
|
||||
@@ -0,0 +1,17 @@
|
||||
# ChatCompletionCreateParamsIgnoreUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatCompletionCreateParamsIgnoreEnum`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsIgnoreEnum = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Prompt
|
||||
# ChatCompletionCreateParamsImage
|
||||
|
||||
|
||||
## Supported Types
|
||||
@@ -1,4 +1,4 @@
|
||||
# JSONSchema
|
||||
# ChatCompletionCreateParamsJSONSchema
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -0,0 +1,14 @@
|
||||
# ChatCompletionCreateParamsMaxPrice
|
||||
|
||||
The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `prompt` | [Optional[models.ChatCompletionCreateParamsPrompt]](../models/chatcompletioncreateparamsprompt.md) | :heavy_minus_sign: | N/A |
|
||||
| `completion` | [Optional[models.ChatCompletionCreateParamsCompletion]](../models/chatcompletioncreateparamscompletion.md) | :heavy_minus_sign: | N/A |
|
||||
| `image` | [Optional[models.ChatCompletionCreateParamsImage]](../models/chatcompletioncreateparamsimage.md) | :heavy_minus_sign: | N/A |
|
||||
| `audio` | [Optional[models.ChatCompletionCreateParamsAudio]](../models/chatcompletioncreateparamsaudio.md) | :heavy_minus_sign: | N/A |
|
||||
| `request` | [Optional[models.ChatCompletionCreateParamsRequest]](../models/chatcompletioncreateparamsrequest.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,4 +1,4 @@
|
||||
# IgnoreEnum
|
||||
# ChatCompletionCreateParamsOnlyEnum
|
||||
|
||||
|
||||
## Values
|
||||
@@ -0,0 +1,17 @@
|
||||
# ChatCompletionCreateParamsOnlyUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatCompletionCreateParamsOnlyEnum`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsOnlyEnum = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# OnlyEnum
|
||||
# ChatCompletionCreateParamsOrderEnum
|
||||
|
||||
|
||||
## Values
|
||||
@@ -0,0 +1,17 @@
|
||||
# ChatCompletionCreateParamsOrderUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatCompletionCreateParamsOrderEnum`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsOrderEnum = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatCompletionCreateParamsPdf
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `engine` | [Optional[models.ChatCompletionCreateParamsPdfEngine]](../models/chatcompletioncreateparamspdfengine.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,4 +1,4 @@
|
||||
# PdfEngine
|
||||
# ChatCompletionCreateParamsPdfEngine
|
||||
|
||||
|
||||
## Values
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatCompletionCreateParamsPluginChainOfThought
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | [models.ChatCompletionCreateParamsIDChainOfThought](../models/chatcompletioncreateparamsidchainofthought.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatCompletionCreateParamsPluginFileParser
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `id` | [models.ChatCompletionCreateParamsIDFileParser](../models/chatcompletioncreateparamsidfileparser.md) | :heavy_check_mark: | N/A |
|
||||
| `max_files` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||
| `pdf` | [Optional[models.ChatCompletionCreateParamsPdf]](../models/chatcompletioncreateparamspdf.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatCompletionCreateParamsPluginModeration
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `id` | [models.ChatCompletionCreateParamsIDModeration](../models/chatcompletioncreateparamsidmoderation.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,29 @@
|
||||
# ChatCompletionCreateParamsPluginUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatCompletionCreateParamsPluginModeration`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsPluginModeration = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatCompletionCreateParamsPluginWeb`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsPluginWeb = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatCompletionCreateParamsPluginChainOfThought`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsPluginChainOfThought = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatCompletionCreateParamsPluginFileParser`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsPluginFileParser = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# ChatCompletionCreateParamsPluginWeb
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `id` | [models.ChatCompletionCreateParamsIDWeb](../models/chatcompletioncreateparamsidweb.md) | :heavy_check_mark: | N/A |
|
||||
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||
| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||
| `engine` | [Optional[models.ChatCompletionCreateParamsEngine]](../models/chatcompletioncreateparamsengine.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,4 +1,4 @@
|
||||
# Completion
|
||||
# ChatCompletionCreateParamsPrompt
|
||||
|
||||
|
||||
## Supported Types
|
||||
@@ -1,4 +1,4 @@
|
||||
# Provider
|
||||
# ChatCompletionCreateParamsProvider
|
||||
|
||||
When multiple model providers are available, optionally indicate your routing preference.
|
||||
|
||||
@@ -9,10 +9,10 @@ When multiple model providers are available, optionally indicate your routing pr
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `allow_fallbacks` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to allow backup providers to serve requests<br/>- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.<br/>- false: use only the primary/custom provider, and return the upstream error if it's unavailable.<br/> |
|
||||
| `require_parameters` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. |
|
||||
| `data_collection` | [OptionalNullable[models.DataCollection]](../models/datacollection.md) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.<br/>- allow: (default) allow providers which store user data non-transiently and may train on it<br/>- deny: use only providers which do not collect user data.<br/> |
|
||||
| `order` | List[[models.Order](../models/order.md)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. |
|
||||
| `only` | List[[models.Only](../models/only.md)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. |
|
||||
| `ignore` | List[[models.Ignore](../models/ignore.md)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. |
|
||||
| `quantizations` | List[[models.Quantization](../models/quantization.md)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. |
|
||||
| `sort` | [OptionalNullable[models.Sort]](../models/sort.md) | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. |
|
||||
| `max_price` | [Optional[models.MaxPrice]](../models/maxprice.md) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. |
|
||||
| `data_collection` | [OptionalNullable[models.ChatCompletionCreateParamsDataCollection]](../models/chatcompletioncreateparamsdatacollection.md) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.<br/>- allow: (default) allow providers which store user data non-transiently and may train on it<br/>- deny: use only providers which do not collect user data.<br/> |
|
||||
| `order` | List[[models.ChatCompletionCreateParamsOrderUnion](../models/chatcompletioncreateparamsorderunion.md)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. |
|
||||
| `only` | List[[models.ChatCompletionCreateParamsOnlyUnion](../models/chatcompletioncreateparamsonlyunion.md)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. |
|
||||
| `ignore` | List[[models.ChatCompletionCreateParamsIgnoreUnion](../models/chatcompletioncreateparamsignoreunion.md)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. |
|
||||
| `quantizations` | List[[models.ChatCompletionCreateParamsQuantization](../models/chatcompletioncreateparamsquantization.md)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. |
|
||||
| `sort` | [OptionalNullable[models.ChatCompletionCreateParamsSort]](../models/chatcompletioncreateparamssort.md) | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. |
|
||||
| `max_price` | [Optional[models.ChatCompletionCreateParamsMaxPrice]](../models/chatcompletioncreateparamsmaxprice.md) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. |
|
||||
@@ -1,4 +1,4 @@
|
||||
# Quantization
|
||||
# ChatCompletionCreateParamsQuantization
|
||||
|
||||
|
||||
## Values
|
||||
@@ -0,0 +1,13 @@
|
||||
# ChatCompletionCreateParamsReasoning
|
||||
|
||||
Reasoning configuration
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Enables reasoning with default settings. Only work for some models. |
|
||||
| `effort` | [OptionalNullable[models.ChatCompletionCreateParamsEffort]](../models/chatcompletioncreateparamseffort.md) | :heavy_minus_sign: | OpenAI-style reasoning effort setting |
|
||||
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | non-OpenAI-style reasoning effort setting |
|
||||
| `exclude` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# ReasoningEffort
|
||||
# ChatCompletionCreateParamsReasoningEffort
|
||||
|
||||
Reasoning effort
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Image
|
||||
# ChatCompletionCreateParamsRequest
|
||||
|
||||
|
||||
## Supported Types
|
||||
@@ -0,0 +1,11 @@
|
||||
# ChatCompletionCreateParamsResponseFormatGrammar
|
||||
|
||||
Custom grammar response format
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [models.ChatCompletionCreateParamsTypeGrammar](../models/chatcompletioncreateparamstypegrammar.md) | :heavy_check_mark: | N/A |
|
||||
| `grammar` | *str* | :heavy_check_mark: | Custom grammar for text generation |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatCompletionCreateParamsResponseFormatJSONObject
|
||||
|
||||
JSON object response format
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [models.ChatCompletionCreateParamsTypeJSONObject](../models/chatcompletioncreateparamstypejsonobject.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,11 @@
|
||||
# ChatCompletionCreateParamsResponseFormatJSONSchema
|
||||
|
||||
JSON Schema response format for structured outputs
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [models.ChatCompletionCreateParamsTypeJSONSchema](../models/chatcompletioncreateparamstypejsonschema.md) | :heavy_check_mark: | N/A |
|
||||
| `json_schema` | [models.ChatCompletionCreateParamsJSONSchema](../models/chatcompletioncreateparamsjsonschema.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatCompletionCreateParamsResponseFormatPython
|
||||
|
||||
Python code response format
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `type` | [models.ChatCompletionCreateParamsTypePython](../models/chatcompletioncreateparamstypepython.md) | :heavy_check_mark: | N/A |
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# ResponseFormatText
|
||||
# ChatCompletionCreateParamsResponseFormatText
|
||||
|
||||
Default text response format
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# ChatCompletionCreateParamsResponseFormatUnion
|
||||
|
||||
Response format configuration
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatCompletionCreateParamsResponseFormatText`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsResponseFormatText = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatCompletionCreateParamsResponseFormatJSONObject`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsResponseFormatJSONObject = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatCompletionCreateParamsResponseFormatJSONSchema`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsResponseFormatJSONSchema = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatCompletionCreateParamsResponseFormatGrammar`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsResponseFormatGrammar = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatCompletionCreateParamsResponseFormatPython`
|
||||
|
||||
```python
|
||||
value: models.ChatCompletionCreateParamsResponseFormatPython = /* values here */
|
||||
```
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Sort
|
||||
# ChatCompletionCreateParamsSort
|
||||
|
||||
The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Stop
|
||||
# ChatCompletionCreateParamsStop
|
||||
|
||||
Stop sequences (up to 4)
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# StreamOptions
|
||||
# ChatCompletionCreateParamsStreamOptions
|
||||
|
||||
Streaming configuration options
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# TypeGrammar
|
||||
# ChatCompletionCreateParamsTypeGrammar
|
||||
|
||||
|
||||
## Values
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# TypeJSONObject
|
||||
# ChatCompletionCreateParamsTypeJSONObject
|
||||
|
||||
|
||||
## Values
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# TypeJSONSchema
|
||||
# ChatCompletionCreateParamsTypeJSONSchema
|
||||
|
||||
|
||||
## Values
|
||||
@@ -1,4 +1,4 @@
|
||||
# TypePython
|
||||
# ChatCompletionCreateParamsTypePython
|
||||
|
||||
|
||||
## Values
|
||||
@@ -0,0 +1,34 @@
|
||||
# ChatStreamCompletionCreateParams
|
||||
|
||||
Chat completion request parameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `messages` | List[[models.ChatCompletionMessageParam](../models/chatcompletionmessageparam.md)] | :heavy_check_mark: | List of messages for the conversation | [<br/>{<br/>"role": "user",<br/>"content": "Hello, how are you?"<br/>}<br/>] |
|
||||
| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | |
|
||||
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | |
|
||||
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | |
|
||||
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | |
|
||||
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | |
|
||||
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens in completion | |
|
||||
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens) | |
|
||||
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | |
|
||||
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | |
|
||||
| `reasoning` | [OptionalNullable[models.ChatStreamCompletionCreateParamsReasoning]](../models/chatstreamcompletioncreateparamsreasoning.md) | :heavy_minus_sign: | Reasoning configuration | |
|
||||
| `response_format` | [Optional[models.ChatStreamCompletionCreateParamsResponseFormatUnion]](../models/chatstreamcompletioncreateparamsresponseformatunion.md) | :heavy_minus_sign: | Response format configuration | |
|
||||
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | |
|
||||
| `stop` | [OptionalNullable[models.ChatStreamCompletionCreateParamsStop]](../models/chatstreamcompletioncreateparamsstop.md) | :heavy_minus_sign: | Stop sequences (up to 4) | |
|
||||
| `stream` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | |
|
||||
| `stream_options` | [OptionalNullable[models.ChatStreamCompletionCreateParamsStreamOptions]](../models/chatstreamcompletioncreateparamsstreamoptions.md) | :heavy_minus_sign: | N/A | |
|
||||
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | |
|
||||
| `tool_choice` | [Optional[models.ChatCompletionToolChoiceOption]](../models/chatcompletiontoolchoiceoption.md) | :heavy_minus_sign: | Tool choice configuration | |
|
||||
| `tools` | List[[models.ChatCompletionTool](../models/chatcompletiontool.md)] | :heavy_minus_sign: | Available tools for function calling | |
|
||||
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | |
|
||||
| `user` | *Optional[str]* | :heavy_minus_sign: | Unique user identifier | |
|
||||
| `fallback_models` | List[*str*] | :heavy_minus_sign: | Order of models to fallback to for this request | |
|
||||
| `reasoning_effort` | [OptionalNullable[models.ChatStreamCompletionCreateParamsReasoningEffort]](../models/chatstreamcompletioncreateparamsreasoningeffort.md) | :heavy_minus_sign: | Reasoning effort | |
|
||||
| `provider` | [OptionalNullable[models.ChatStreamCompletionCreateParamsProvider]](../models/chatstreamcompletioncreateparamsprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | |
|
||||
| `plugins` | List[[models.ChatStreamCompletionCreateParamsPluginUnion](../models/chatstreamcompletioncreateparamspluginunion.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | |
|
||||
@@ -0,0 +1,23 @@
|
||||
# ChatStreamCompletionCreateParamsAudio
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `float`
|
||||
|
||||
```python
|
||||
value: float = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
### `Any`
|
||||
|
||||
```python
|
||||
value: Any = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# ChatStreamCompletionCreateParamsCompletion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `float`
|
||||
|
||||
```python
|
||||
value: float = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
### `Any`
|
||||
|
||||
```python
|
||||
value: Any = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# ChatStreamCompletionCreateParamsDataCollection
|
||||
|
||||
Data collection setting. If no available model provider meets the requirement, your request will return an error.
|
||||
- allow: (default) allow providers which store user data non-transiently and may train on it
|
||||
- deny: use only providers which do not collect user data.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `DENY` | deny |
|
||||
| `ALLOW` | allow |
|
||||
@@ -0,0 +1,13 @@
|
||||
# ChatStreamCompletionCreateParamsEffort
|
||||
|
||||
OpenAI-style reasoning effort setting
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `HIGH` | high |
|
||||
| `MEDIUM` | medium |
|
||||
| `LOW` | low |
|
||||
| `MINIMAL` | minimal |
|
||||
@@ -0,0 +1,9 @@
|
||||
# ChatStreamCompletionCreateParamsEngine
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------- | -------- |
|
||||
| `NATIVE` | native |
|
||||
| `EXA` | exa |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsIDChainOfThought
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------ | ------------------ |
|
||||
| `CHAIN_OF_THOUGHT` | chain-of-thought |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsIDFileParser
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `FILE_PARSER` | file-parser |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsIDModeration
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `MODERATION` | moderation |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsIDWeb
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `WEB` | web |
|
||||
@@ -0,0 +1,85 @@
|
||||
# ChatStreamCompletionCreateParamsIgnoreEnum
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------ | ------------------ |
|
||||
| `ANY_SCALE` | AnyScale |
|
||||
| `CENT_ML` | Cent-ML |
|
||||
| `HUGGING_FACE` | HuggingFace |
|
||||
| `HYPERBOLIC_2` | Hyperbolic 2 |
|
||||
| `LEPTON` | Lepton |
|
||||
| `LYNN_2` | Lynn 2 |
|
||||
| `LYNN` | Lynn |
|
||||
| `MANCER` | Mancer |
|
||||
| `MODAL` | Modal |
|
||||
| `OCTO_AI` | OctoAI |
|
||||
| `RECURSAL` | Recursal |
|
||||
| `REFLECTION` | Reflection |
|
||||
| `REPLICATE` | Replicate |
|
||||
| `SAMBA_NOVA_2` | SambaNova 2 |
|
||||
| `SF_COMPUTE` | SF Compute |
|
||||
| `TOGETHER_2` | Together 2 |
|
||||
| `ONE_DOT_AI` | 01.AI |
|
||||
| `AI21` | AI21 |
|
||||
| `AION_LABS` | AionLabs |
|
||||
| `ALIBABA` | Alibaba |
|
||||
| `AMAZON_BEDROCK` | Amazon Bedrock |
|
||||
| `ANTHROPIC` | Anthropic |
|
||||
| `ATLAS_CLOUD` | AtlasCloud |
|
||||
| `ATOMA` | Atoma |
|
||||
| `AVIAN` | Avian |
|
||||
| `AZURE` | Azure |
|
||||
| `BASE_TEN` | BaseTen |
|
||||
| `CEREBRAS` | Cerebras |
|
||||
| `CHUTES` | Chutes |
|
||||
| `CLOUDFLARE` | Cloudflare |
|
||||
| `COHERE` | Cohere |
|
||||
| `CROF_AI` | CrofAI |
|
||||
| `CRUSOE` | Crusoe |
|
||||
| `DEEP_INFRA` | DeepInfra |
|
||||
| `DEEP_SEEK` | DeepSeek |
|
||||
| `ENFER` | Enfer |
|
||||
| `FEATHERLESS` | Featherless |
|
||||
| `FIREWORKS` | Fireworks |
|
||||
| `FRIENDLI` | Friendli |
|
||||
| `GMI_CLOUD` | GMICloud |
|
||||
| `GOOGLE` | Google |
|
||||
| `GOOGLE_AI_STUDIO` | Google AI Studio |
|
||||
| `GROQ` | Groq |
|
||||
| `HYPERBOLIC` | Hyperbolic |
|
||||
| `INCEPTION` | Inception |
|
||||
| `INFERENCE_NET` | InferenceNet |
|
||||
| `INFERMATIC` | Infermatic |
|
||||
| `INFLECTION` | Inflection |
|
||||
| `INO_CLOUD` | InoCloud |
|
||||
| `KLUSTER` | Kluster |
|
||||
| `LAMBDA` | Lambda |
|
||||
| `LIQUID` | Liquid |
|
||||
| `MANCER_2` | Mancer 2 |
|
||||
| `META` | Meta |
|
||||
| `MINIMAX` | Minimax |
|
||||
| `MISTRAL` | Mistral |
|
||||
| `MOONSHOT_AI` | Moonshot AI |
|
||||
| `MORPH` | Morph |
|
||||
| `N_COMPASS` | NCompass |
|
||||
| `NEBIUS` | Nebius |
|
||||
| `NEXT_BIT` | NextBit |
|
||||
| `NINETEEN` | Nineteen |
|
||||
| `NOVITA` | Novita |
|
||||
| `OPEN_AI` | OpenAI |
|
||||
| `OPEN_INFERENCE` | OpenInference |
|
||||
| `PARASAIL` | Parasail |
|
||||
| `PERPLEXITY` | Perplexity |
|
||||
| `PHALA` | Phala |
|
||||
| `SAMBA_NOVA` | SambaNova |
|
||||
| `STEALTH` | Stealth |
|
||||
| `SWITCHPOINT` | Switchpoint |
|
||||
| `TARGON` | Targon |
|
||||
| `TOGETHER` | Together |
|
||||
| `UBICLOUD` | Ubicloud |
|
||||
| `VENICE` | Venice |
|
||||
| `WAND_B` | WandB |
|
||||
| `X_AI` | xAI |
|
||||
| `Z_AI` | Z.AI |
|
||||
@@ -0,0 +1,17 @@
|
||||
# ChatStreamCompletionCreateParamsIgnoreUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsIgnoreEnum`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsIgnoreEnum = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# ChatStreamCompletionCreateParamsImage
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `float`
|
||||
|
||||
```python
|
||||
value: float = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
### `Any`
|
||||
|
||||
```python
|
||||
value: Any = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# ChatStreamCompletionCreateParamsJSONSchema
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `name` | *str* | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) |
|
||||
| `description` | *Optional[str]* | :heavy_minus_sign: | Schema description for the model |
|
||||
| `schema_` | [Optional[models.ResponseFormatJSONSchemaSchema]](../models/responseformatjsonschemaschema.md) | :heavy_minus_sign: | The schema for the response format, described as a JSON Schema object |
|
||||
| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable strict schema adherence |
|
||||
@@ -0,0 +1,14 @@
|
||||
# ChatStreamCompletionCreateParamsMaxPrice
|
||||
|
||||
The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `prompt` | [Optional[models.ChatStreamCompletionCreateParamsPrompt]](../models/chatstreamcompletioncreateparamsprompt.md) | :heavy_minus_sign: | N/A |
|
||||
| `completion` | [Optional[models.ChatStreamCompletionCreateParamsCompletion]](../models/chatstreamcompletioncreateparamscompletion.md) | :heavy_minus_sign: | N/A |
|
||||
| `image` | [Optional[models.ChatStreamCompletionCreateParamsImage]](../models/chatstreamcompletioncreateparamsimage.md) | :heavy_minus_sign: | N/A |
|
||||
| `audio` | [Optional[models.ChatStreamCompletionCreateParamsAudio]](../models/chatstreamcompletioncreateparamsaudio.md) | :heavy_minus_sign: | N/A |
|
||||
| `request` | [Optional[models.ChatStreamCompletionCreateParamsRequest]](../models/chatstreamcompletioncreateparamsrequest.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,85 @@
|
||||
# ChatStreamCompletionCreateParamsOnlyEnum
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------ | ------------------ |
|
||||
| `ANY_SCALE` | AnyScale |
|
||||
| `CENT_ML` | Cent-ML |
|
||||
| `HUGGING_FACE` | HuggingFace |
|
||||
| `HYPERBOLIC_2` | Hyperbolic 2 |
|
||||
| `LEPTON` | Lepton |
|
||||
| `LYNN_2` | Lynn 2 |
|
||||
| `LYNN` | Lynn |
|
||||
| `MANCER` | Mancer |
|
||||
| `MODAL` | Modal |
|
||||
| `OCTO_AI` | OctoAI |
|
||||
| `RECURSAL` | Recursal |
|
||||
| `REFLECTION` | Reflection |
|
||||
| `REPLICATE` | Replicate |
|
||||
| `SAMBA_NOVA_2` | SambaNova 2 |
|
||||
| `SF_COMPUTE` | SF Compute |
|
||||
| `TOGETHER_2` | Together 2 |
|
||||
| `ONE_DOT_AI` | 01.AI |
|
||||
| `AI21` | AI21 |
|
||||
| `AION_LABS` | AionLabs |
|
||||
| `ALIBABA` | Alibaba |
|
||||
| `AMAZON_BEDROCK` | Amazon Bedrock |
|
||||
| `ANTHROPIC` | Anthropic |
|
||||
| `ATLAS_CLOUD` | AtlasCloud |
|
||||
| `ATOMA` | Atoma |
|
||||
| `AVIAN` | Avian |
|
||||
| `AZURE` | Azure |
|
||||
| `BASE_TEN` | BaseTen |
|
||||
| `CEREBRAS` | Cerebras |
|
||||
| `CHUTES` | Chutes |
|
||||
| `CLOUDFLARE` | Cloudflare |
|
||||
| `COHERE` | Cohere |
|
||||
| `CROF_AI` | CrofAI |
|
||||
| `CRUSOE` | Crusoe |
|
||||
| `DEEP_INFRA` | DeepInfra |
|
||||
| `DEEP_SEEK` | DeepSeek |
|
||||
| `ENFER` | Enfer |
|
||||
| `FEATHERLESS` | Featherless |
|
||||
| `FIREWORKS` | Fireworks |
|
||||
| `FRIENDLI` | Friendli |
|
||||
| `GMI_CLOUD` | GMICloud |
|
||||
| `GOOGLE` | Google |
|
||||
| `GOOGLE_AI_STUDIO` | Google AI Studio |
|
||||
| `GROQ` | Groq |
|
||||
| `HYPERBOLIC` | Hyperbolic |
|
||||
| `INCEPTION` | Inception |
|
||||
| `INFERENCE_NET` | InferenceNet |
|
||||
| `INFERMATIC` | Infermatic |
|
||||
| `INFLECTION` | Inflection |
|
||||
| `INO_CLOUD` | InoCloud |
|
||||
| `KLUSTER` | Kluster |
|
||||
| `LAMBDA` | Lambda |
|
||||
| `LIQUID` | Liquid |
|
||||
| `MANCER_2` | Mancer 2 |
|
||||
| `META` | Meta |
|
||||
| `MINIMAX` | Minimax |
|
||||
| `MISTRAL` | Mistral |
|
||||
| `MOONSHOT_AI` | Moonshot AI |
|
||||
| `MORPH` | Morph |
|
||||
| `N_COMPASS` | NCompass |
|
||||
| `NEBIUS` | Nebius |
|
||||
| `NEXT_BIT` | NextBit |
|
||||
| `NINETEEN` | Nineteen |
|
||||
| `NOVITA` | Novita |
|
||||
| `OPEN_AI` | OpenAI |
|
||||
| `OPEN_INFERENCE` | OpenInference |
|
||||
| `PARASAIL` | Parasail |
|
||||
| `PERPLEXITY` | Perplexity |
|
||||
| `PHALA` | Phala |
|
||||
| `SAMBA_NOVA` | SambaNova |
|
||||
| `STEALTH` | Stealth |
|
||||
| `SWITCHPOINT` | Switchpoint |
|
||||
| `TARGON` | Targon |
|
||||
| `TOGETHER` | Together |
|
||||
| `UBICLOUD` | Ubicloud |
|
||||
| `VENICE` | Venice |
|
||||
| `WAND_B` | WandB |
|
||||
| `X_AI` | xAI |
|
||||
| `Z_AI` | Z.AI |
|
||||
@@ -0,0 +1,17 @@
|
||||
# ChatStreamCompletionCreateParamsOnlyUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsOnlyEnum`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsOnlyEnum = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,85 @@
|
||||
# ChatStreamCompletionCreateParamsOrderEnum
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------ | ------------------ |
|
||||
| `ANY_SCALE` | AnyScale |
|
||||
| `CENT_ML` | Cent-ML |
|
||||
| `HUGGING_FACE` | HuggingFace |
|
||||
| `HYPERBOLIC_2` | Hyperbolic 2 |
|
||||
| `LEPTON` | Lepton |
|
||||
| `LYNN_2` | Lynn 2 |
|
||||
| `LYNN` | Lynn |
|
||||
| `MANCER` | Mancer |
|
||||
| `MODAL` | Modal |
|
||||
| `OCTO_AI` | OctoAI |
|
||||
| `RECURSAL` | Recursal |
|
||||
| `REFLECTION` | Reflection |
|
||||
| `REPLICATE` | Replicate |
|
||||
| `SAMBA_NOVA_2` | SambaNova 2 |
|
||||
| `SF_COMPUTE` | SF Compute |
|
||||
| `TOGETHER_2` | Together 2 |
|
||||
| `ONE_DOT_AI` | 01.AI |
|
||||
| `AI21` | AI21 |
|
||||
| `AION_LABS` | AionLabs |
|
||||
| `ALIBABA` | Alibaba |
|
||||
| `AMAZON_BEDROCK` | Amazon Bedrock |
|
||||
| `ANTHROPIC` | Anthropic |
|
||||
| `ATLAS_CLOUD` | AtlasCloud |
|
||||
| `ATOMA` | Atoma |
|
||||
| `AVIAN` | Avian |
|
||||
| `AZURE` | Azure |
|
||||
| `BASE_TEN` | BaseTen |
|
||||
| `CEREBRAS` | Cerebras |
|
||||
| `CHUTES` | Chutes |
|
||||
| `CLOUDFLARE` | Cloudflare |
|
||||
| `COHERE` | Cohere |
|
||||
| `CROF_AI` | CrofAI |
|
||||
| `CRUSOE` | Crusoe |
|
||||
| `DEEP_INFRA` | DeepInfra |
|
||||
| `DEEP_SEEK` | DeepSeek |
|
||||
| `ENFER` | Enfer |
|
||||
| `FEATHERLESS` | Featherless |
|
||||
| `FIREWORKS` | Fireworks |
|
||||
| `FRIENDLI` | Friendli |
|
||||
| `GMI_CLOUD` | GMICloud |
|
||||
| `GOOGLE` | Google |
|
||||
| `GOOGLE_AI_STUDIO` | Google AI Studio |
|
||||
| `GROQ` | Groq |
|
||||
| `HYPERBOLIC` | Hyperbolic |
|
||||
| `INCEPTION` | Inception |
|
||||
| `INFERENCE_NET` | InferenceNet |
|
||||
| `INFERMATIC` | Infermatic |
|
||||
| `INFLECTION` | Inflection |
|
||||
| `INO_CLOUD` | InoCloud |
|
||||
| `KLUSTER` | Kluster |
|
||||
| `LAMBDA` | Lambda |
|
||||
| `LIQUID` | Liquid |
|
||||
| `MANCER_2` | Mancer 2 |
|
||||
| `META` | Meta |
|
||||
| `MINIMAX` | Minimax |
|
||||
| `MISTRAL` | Mistral |
|
||||
| `MOONSHOT_AI` | Moonshot AI |
|
||||
| `MORPH` | Morph |
|
||||
| `N_COMPASS` | NCompass |
|
||||
| `NEBIUS` | Nebius |
|
||||
| `NEXT_BIT` | NextBit |
|
||||
| `NINETEEN` | Nineteen |
|
||||
| `NOVITA` | Novita |
|
||||
| `OPEN_AI` | OpenAI |
|
||||
| `OPEN_INFERENCE` | OpenInference |
|
||||
| `PARASAIL` | Parasail |
|
||||
| `PERPLEXITY` | Perplexity |
|
||||
| `PHALA` | Phala |
|
||||
| `SAMBA_NOVA` | SambaNova |
|
||||
| `STEALTH` | Stealth |
|
||||
| `SWITCHPOINT` | Switchpoint |
|
||||
| `TARGON` | Targon |
|
||||
| `TOGETHER` | Together |
|
||||
| `UBICLOUD` | Ubicloud |
|
||||
| `VENICE` | Venice |
|
||||
| `WAND_B` | WandB |
|
||||
| `X_AI` | xAI |
|
||||
| `Z_AI` | Z.AI |
|
||||
@@ -0,0 +1,17 @@
|
||||
# ChatStreamCompletionCreateParamsOrderUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsOrderEnum`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsOrderEnum = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsPdf
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `engine` | [Optional[models.ChatStreamCompletionCreateParamsPdfEngine]](../models/chatstreamcompletioncreateparamspdfengine.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatStreamCompletionCreateParamsPdfEngine
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `MISTRAL_OCR` | mistral-ocr |
|
||||
| `PDF_TEXT` | pdf-text |
|
||||
| `NATIVE` | native |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsPluginChainOfThought
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | [models.ChatStreamCompletionCreateParamsIDChainOfThought](../models/chatstreamcompletioncreateparamsidchainofthought.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatStreamCompletionCreateParamsPluginFileParser
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | [models.ChatStreamCompletionCreateParamsIDFileParser](../models/chatstreamcompletioncreateparamsidfileparser.md) | :heavy_check_mark: | N/A |
|
||||
| `max_files` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||
| `pdf` | [Optional[models.ChatStreamCompletionCreateParamsPdf]](../models/chatstreamcompletioncreateparamspdf.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsPluginModeration
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | [models.ChatStreamCompletionCreateParamsIDModeration](../models/chatstreamcompletioncreateparamsidmoderation.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,29 @@
|
||||
# ChatStreamCompletionCreateParamsPluginUnion
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsPluginModeration`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsPluginModeration = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsPluginWeb`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsPluginWeb = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsPluginChainOfThought`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsPluginChainOfThought = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsPluginFileParser`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsPluginFileParser = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# ChatStreamCompletionCreateParamsPluginWeb
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | [models.ChatStreamCompletionCreateParamsIDWeb](../models/chatstreamcompletioncreateparamsidweb.md) | :heavy_check_mark: | N/A |
|
||||
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A |
|
||||
| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||
| `engine` | [Optional[models.ChatStreamCompletionCreateParamsEngine]](../models/chatstreamcompletioncreateparamsengine.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,23 @@
|
||||
# ChatStreamCompletionCreateParamsPrompt
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `float`
|
||||
|
||||
```python
|
||||
value: float = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
### `Any`
|
||||
|
||||
```python
|
||||
value: Any = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# ChatStreamCompletionCreateParamsProvider
|
||||
|
||||
When multiple model providers are available, optionally indicate your routing preference.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `allow_fallbacks` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to allow backup providers to serve requests<br/>- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.<br/>- false: use only the primary/custom provider, and return the upstream error if it's unavailable.<br/> |
|
||||
| `require_parameters` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. |
|
||||
| `data_collection` | [OptionalNullable[models.ChatStreamCompletionCreateParamsDataCollection]](../models/chatstreamcompletioncreateparamsdatacollection.md) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.<br/>- allow: (default) allow providers which store user data non-transiently and may train on it<br/>- deny: use only providers which do not collect user data.<br/> |
|
||||
| `order` | List[[models.ChatStreamCompletionCreateParamsOrderUnion](../models/chatstreamcompletioncreateparamsorderunion.md)] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. |
|
||||
| `only` | List[[models.ChatStreamCompletionCreateParamsOnlyUnion](../models/chatstreamcompletioncreateparamsonlyunion.md)] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. |
|
||||
| `ignore` | List[[models.ChatStreamCompletionCreateParamsIgnoreUnion](../models/chatstreamcompletioncreateparamsignoreunion.md)] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. |
|
||||
| `quantizations` | List[[models.ChatStreamCompletionCreateParamsQuantization](../models/chatstreamcompletioncreateparamsquantization.md)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. |
|
||||
| `sort` | [OptionalNullable[models.ChatStreamCompletionCreateParamsSort]](../models/chatstreamcompletioncreateparamssort.md) | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. |
|
||||
| `max_price` | [Optional[models.ChatStreamCompletionCreateParamsMaxPrice]](../models/chatstreamcompletioncreateparamsmaxprice.md) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. |
|
||||
@@ -0,0 +1,16 @@
|
||||
# ChatStreamCompletionCreateParamsQuantization
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `INT4` | int4 |
|
||||
| `INT8` | int8 |
|
||||
| `FP4` | fp4 |
|
||||
| `FP6` | fp6 |
|
||||
| `FP8` | fp8 |
|
||||
| `FP16` | fp16 |
|
||||
| `BF16` | bf16 |
|
||||
| `FP32` | fp32 |
|
||||
| `UNKNOWN` | unknown |
|
||||
@@ -0,0 +1,13 @@
|
||||
# ChatStreamCompletionCreateParamsReasoning
|
||||
|
||||
Reasoning configuration
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Enables reasoning with default settings. Only work for some models. |
|
||||
| `effort` | [OptionalNullable[models.ChatStreamCompletionCreateParamsEffort]](../models/chatstreamcompletioncreateparamseffort.md) | :heavy_minus_sign: | OpenAI-style reasoning effort setting |
|
||||
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | non-OpenAI-style reasoning effort setting |
|
||||
| `exclude` | *Optional[bool]* | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,13 @@
|
||||
# ChatStreamCompletionCreateParamsReasoningEffort
|
||||
|
||||
Reasoning effort
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `HIGH` | high |
|
||||
| `MEDIUM` | medium |
|
||||
| `LOW` | low |
|
||||
| `MINIMAL` | minimal |
|
||||
@@ -0,0 +1,23 @@
|
||||
# ChatStreamCompletionCreateParamsRequest
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `float`
|
||||
|
||||
```python
|
||||
value: float = /* values here */
|
||||
```
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
### `Any`
|
||||
|
||||
```python
|
||||
value: Any = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# ChatStreamCompletionCreateParamsResponseFormatGrammar
|
||||
|
||||
Custom grammar response format
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [models.ChatStreamCompletionCreateParamsTypeGrammar](../models/chatstreamcompletioncreateparamstypegrammar.md) | :heavy_check_mark: | N/A |
|
||||
| `grammar` | *str* | :heavy_check_mark: | Custom grammar for text generation |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatStreamCompletionCreateParamsResponseFormatJSONObject
|
||||
|
||||
JSON object response format
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [models.ChatStreamCompletionCreateParamsTypeJSONObject](../models/chatstreamcompletioncreateparamstypejsonobject.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,11 @@
|
||||
# ChatStreamCompletionCreateParamsResponseFormatJSONSchema
|
||||
|
||||
JSON Schema response format for structured outputs
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [models.ChatStreamCompletionCreateParamsTypeJSONSchema](../models/chatstreamcompletioncreateparamstypejsonschema.md) | :heavy_check_mark: | N/A |
|
||||
| `json_schema` | [models.ChatStreamCompletionCreateParamsJSONSchema](../models/chatstreamcompletioncreateparamsjsonschema.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatStreamCompletionCreateParamsResponseFormatPython
|
||||
|
||||
Python code response format
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | [models.ChatStreamCompletionCreateParamsTypePython](../models/chatstreamcompletioncreateparamstypepython.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatStreamCompletionCreateParamsResponseFormatText
|
||||
|
||||
Default text response format
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [models.ChatStreamCompletionCreateParamsTypeText](../models/chatstreamcompletioncreateparamstypetext.md) | :heavy_check_mark: | N/A |
|
||||
@@ -0,0 +1,37 @@
|
||||
# ChatStreamCompletionCreateParamsResponseFormatUnion
|
||||
|
||||
Response format configuration
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsResponseFormatText`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsResponseFormatText = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsResponseFormatJSONObject`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsResponseFormatJSONObject = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsResponseFormatJSONSchema`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsResponseFormatJSONSchema = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsResponseFormatGrammar`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsResponseFormatGrammar = /* values here */
|
||||
```
|
||||
|
||||
### `models.ChatStreamCompletionCreateParamsResponseFormatPython`
|
||||
|
||||
```python
|
||||
value: models.ChatStreamCompletionCreateParamsResponseFormatPython = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# ChatStreamCompletionCreateParamsSort
|
||||
|
||||
The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `PRICE` | price |
|
||||
| `THROUGHPUT` | throughput |
|
||||
| `LATENCY` | latency |
|
||||
@@ -0,0 +1,25 @@
|
||||
# ChatStreamCompletionCreateParamsStop
|
||||
|
||||
Stop sequences (up to 4)
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `str`
|
||||
|
||||
```python
|
||||
value: str = /* values here */
|
||||
```
|
||||
|
||||
### `List[str]`
|
||||
|
||||
```python
|
||||
value: List[str] = /* values here */
|
||||
```
|
||||
|
||||
### `Any`
|
||||
|
||||
```python
|
||||
value: Any = /* values here */
|
||||
```
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# ChatStreamCompletionCreateParamsStreamOptions
|
||||
|
||||
Streaming configuration options
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
||||
| `include_usage` | *Optional[bool]* | :heavy_minus_sign: | Include usage information in streaming response |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsTypeGrammar
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `GRAMMAR` | grammar |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsTypeJSONObject
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `JSON_OBJECT` | json_object |
|
||||
@@ -0,0 +1,8 @@
|
||||
# ChatStreamCompletionCreateParamsTypeJSONSchema
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `JSON_SCHEMA` | json_schema |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user