Compare commits

..
1 Commits
Author SHA1 Message Date
OpenRouter Team 910fab76fd Commits included in this export:
- 24d3f0ee1c2aa19a62f7902836034080b9246813
  - 68922847c2969b773887310eb7aa9a814e199c5a
  - 729ee2338c39df22461526153e7f4ba868fd498e
  - e1074ff86fccf5e48406b7595298873106d3cc5a
  - 123bbdaf841d299162a82ee2573adfbb70a45b8f
  - ac457b8a8dad98fdf5ddcae8dd4711361cea3084
  - ea825199f4c59dd68fec01cf8d18a582963c9f25
  - 4d48e4f6bb936e785787314a965298da6b78fea0
  - 718729a573ee98893a4408d5a52ab4686661fe54
  - b867adcde6b64f3f2a11c4626254b39098e4b0b4
  - 21912c097b4066d109766c6b4492826595cd57c5
  - bc1ed85adc976a4634ca8a41b82e4fc2c39a864f
  - d145c89c941937a312ed1357590d2bfda9a3603d
  - 12f05b5dee397ead47cfcd545a7a2e3c7ff57524
  - dd28f75a19a015809797c7abf3f8758f7c37262e
  - c96e569781e07ab44172d9c69940ec17bafd81f4
  - c9d5a90e3c2b5077a2bdd49773f1a46d1a5a79c7
  - 58b08f87116ceab9076de2fdc0a4c74c919b44c4

GitOrigin-RevId: 24d3f0ee1c2aa19a62f7902836034080b9246813
2026-01-30 22:57:33 +00:00
583 changed files with 7280 additions and 27234 deletions
+91 -322
View File
@@ -1,12 +1,12 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: cfd52247-6a25-4c6d-bbce-fe6fce0cd69d id: cfd52247-6a25-4c6d-bbce-fe6fce0cd69d
management: management:
docChecksum: 3733fc486836d444d30b7d3ac33fab93 docChecksum: 4cc0fd0666832ffd4990d56ea4d60d8a
docVersion: 1.0.0 docVersion: 1.0.0
speakeasyVersion: 1.666.0 speakeasyVersion: 1.666.0
generationVersion: 2.768.0 generationVersion: 2.768.0
releaseVersion: 0.7.12 releaseVersion: 0.4.1
configChecksum: 706cd700670d47927ea49b73ad135364 configChecksum: 25abf1229cf681cc15488099121619e5
repoURL: https://github.com/OpenRouterTeam/python-sdk.git repoURL: https://github.com/OpenRouterTeam/python-sdk.git
installationURL: https://github.com/OpenRouterTeam/python-sdk.git installationURL: https://github.com/OpenRouterTeam/python-sdk.git
published: true published: true
@@ -14,7 +14,6 @@ features:
python: python:
acceptHeaders: 3.0.0 acceptHeaders: 3.0.0
additionalDependencies: 1.0.0 additionalDependencies: 1.0.0
additionalProperties: 1.0.1
constsAndDefaults: 1.0.5 constsAndDefaults: 1.0.5
core: 5.23.13 core: 5.23.13
defaultEnabledRetries: 0.2.0 defaultEnabledRetries: 0.2.0
@@ -50,155 +49,93 @@ generatedFiles:
- .gitattributes - .gitattributes
- .vscode/settings.json - .vscode/settings.json
- USAGE.md - USAGE.md
- docs/components/action.md
- docs/components/actionfindinpage.md
- docs/components/actionopenpage.md
- docs/components/actionsearch.md
- docs/components/activityitem.md - docs/components/activityitem.md
- docs/components/allowedtools.md
- docs/components/always.md
- docs/components/architecture.md - docs/components/architecture.md
- docs/components/assistantmessage.md - docs/components/assistantmessage.md
- docs/components/assistantmessagecontent.md - docs/components/assistantmessagecontent.md
- docs/components/assistantmessageimages.md - docs/components/assistantmessageimageurl.md
- docs/components/assistantmessageimagesimageurl.md
- docs/components/assistantmessagerole.md
- docs/components/background.md
- docs/components/badgatewayresponseerrordata.md - docs/components/badgatewayresponseerrordata.md
- docs/components/badrequestresponseerrordata.md - docs/components/badrequestresponseerrordata.md
- docs/components/by.md
- docs/components/cachecontrol.md
- docs/components/chainid.md - docs/components/chainid.md
- docs/components/chatcompletionaudiooutput.md
- docs/components/chatcompletionfinishreason.md - docs/components/chatcompletionfinishreason.md
- docs/components/chaterrorerror.md
- docs/components/chatgenerationparams.md - docs/components/chatgenerationparams.md
- docs/components/chatgenerationparamsby.md
- docs/components/chatgenerationparamsidautorouter.md
- docs/components/chatgenerationparamsidfileparser.md
- docs/components/chatgenerationparamsidmoderation.md
- docs/components/chatgenerationparamsidresponsehealing.md
- docs/components/chatgenerationparamsidweb.md
- docs/components/chatgenerationparamsignore.md
- docs/components/chatgenerationparamsimageconfig.md - docs/components/chatgenerationparamsimageconfig.md
- docs/components/chatgenerationparamsmaxprice.md
- docs/components/chatgenerationparamsonly.md
- docs/components/chatgenerationparamsorder.md
- docs/components/chatgenerationparamspartition.md
- docs/components/chatgenerationparamspluginautorouter.md
- docs/components/chatgenerationparamspluginfileparser.md
- docs/components/chatgenerationparamspluginmoderation.md
- docs/components/chatgenerationparamspluginresponsehealing.md
- docs/components/chatgenerationparamspluginunion.md
- docs/components/chatgenerationparamspluginweb.md
- docs/components/chatgenerationparamsprovider.md
- docs/components/chatgenerationparamsprovidersort.md
- docs/components/chatgenerationparamsprovidersortconfig.md
- docs/components/chatgenerationparamsprovidersortconfigenum.md
- docs/components/chatgenerationparamsprovidersortconfigunion.md
- docs/components/chatgenerationparamssortenum.md
- docs/components/chatgenerationparamssortunion.md
- docs/components/chatgenerationparamstrace.md
- docs/components/chatgenerationparamsttl.md
- docs/components/chatgenerationparamstype.md
- docs/components/chatgenerationtokenusage.md - docs/components/chatgenerationtokenusage.md
- docs/components/chatmessagecontentitem.md - docs/components/chatmessagecontentitem.md
- docs/components/chatmessagecontentitem1.md
- docs/components/chatmessagecontentitemaudio.md - docs/components/chatmessagecontentitemaudio.md
- docs/components/chatmessagecontentitemaudioinputaudio.md - docs/components/chatmessagecontentitemaudioinputaudio.md
- docs/components/chatmessagecontentitemaudiotype.md
- docs/components/chatmessagecontentitemcachecontrol.md - docs/components/chatmessagecontentitemcachecontrol.md
- docs/components/chatmessagecontentitemcachecontrolttl.md
- docs/components/chatmessagecontentitemcachecontroltype.md
- docs/components/chatmessagecontentitemfile.md
- docs/components/chatmessagecontentitemfiletype.md
- docs/components/chatmessagecontentitemimage.md - docs/components/chatmessagecontentitemimage.md
- docs/components/chatmessagecontentitemimagedetail.md - docs/components/chatmessagecontentitemimagedetail.md
- docs/components/chatmessagecontentitemimageimageurl.md - docs/components/chatmessagecontentitemimageimageurl.md
- docs/components/chatmessagecontentitemimagetype.md
- docs/components/chatmessagecontentitemtext.md - docs/components/chatmessagecontentitemtext.md
- docs/components/chatmessagecontentitemtexttype.md
- docs/components/chatmessagecontentitemvideo.md - docs/components/chatmessagecontentitemvideo.md
- docs/components/chatmessagecontentitemvideolegacy.md - docs/components/chatmessagecontentitemvideoinputvideo.md
- docs/components/chatmessagecontentitemvideolegacytype.md - docs/components/chatmessagecontentitemvideovideourl.md
- docs/components/chatmessagecontentitemvideotype.md
- docs/components/chatmessagetokenlogprob.md - docs/components/chatmessagetokenlogprob.md
- docs/components/chatmessagetokenlogprobs.md - docs/components/chatmessagetokenlogprobs.md
- docs/components/chatmessagetokenlogprobtoplogprob.md - docs/components/chatmessagetokenlogprobtoplogprob.md
- docs/components/chatmessagetoolcall.md - docs/components/chatmessagetoolcall.md
- docs/components/chatmessagetoolcallfunction.md - docs/components/chatmessagetoolcallfunction.md
- docs/components/chatmessagetoolcalltype.md
- docs/components/chatresponse.md - docs/components/chatresponse.md
- docs/components/chatresponsechoice.md - docs/components/chatresponsechoice.md
- docs/components/chatresponseobject.md
- docs/components/chatstreamingchoice.md - docs/components/chatstreamingchoice.md
- docs/components/chatstreamingmessagechunk.md - docs/components/chatstreamingmessagechunk.md
- docs/components/chatstreamingmessagechunkrole.md - docs/components/chatstreamingmessagechunkrole.md
- docs/components/chatstreamingmessagetoolcall.md - docs/components/chatstreamingmessagetoolcall.md
- docs/components/chatstreamingmessagetoolcallfunction.md - docs/components/chatstreamingmessagetoolcallfunction.md
- docs/components/chatstreamingmessagetoolcalltype.md
- docs/components/chatstreamingresponsechunk.md - docs/components/chatstreamingresponsechunk.md
- docs/components/chatstreamingresponsechunkobject.md - docs/components/chatstreamingresponsechunkdata.md
- docs/components/chatstreamingresponsechunkerror.md
- docs/components/chatstreamoptions.md - docs/components/chatstreamoptions.md
- docs/components/code.md - docs/components/code.md
- docs/components/codeenum.md
- docs/components/completion.md
- docs/components/completiontokensdetails.md - docs/components/completiontokensdetails.md
- docs/components/compoundfilter.md
- docs/components/compoundfiltertype.md
- docs/components/connectorid.md
- docs/components/container.md
- docs/components/containerauto.md
- docs/components/containertype.md
- docs/components/costdetails.md - docs/components/costdetails.md
- docs/components/createchargerequest.md - docs/components/createchargerequest.md
- docs/components/data.md
- docs/components/datacollection.md - docs/components/datacollection.md
- docs/components/debugoptions.md - docs/components/debug.md
- docs/components/defaultparameters.md - docs/components/defaultparameters.md
- docs/components/developermessage.md - docs/components/developermessage.md
- docs/components/developermessagecontent.md - docs/components/developermessagecontent.md
- docs/components/developermessagerole.md
- docs/components/edgenetworktimeoutresponseerrordata.md - docs/components/edgenetworktimeoutresponseerrordata.md
- docs/components/effort.md - docs/components/effort.md
- docs/components/endpointstatus.md - docs/components/endpointstatus.md
- docs/components/environment.md - docs/components/engine.md
- docs/components/error.md
- docs/components/file.md
- docs/components/filecitation.md - docs/components/filecitation.md
- docs/components/filecitationtype.md - docs/components/filecitationtype.md
- docs/components/filepath.md - docs/components/filepath.md
- docs/components/filepathtype.md - docs/components/filepathtype.md
- docs/components/filters.md
- docs/components/filterstype.md
- docs/components/forbiddenresponseerrordata.md - docs/components/forbiddenresponseerrordata.md
- docs/components/format_.md - docs/components/idautorouter.md
- docs/components/formatgrammar.md - docs/components/idfileparser.md
- docs/components/formattext.md - docs/components/idmoderation.md
- docs/components/formattypegrammar.md - docs/components/idresponsehealing.md
- docs/components/formattypetext.md - docs/components/idweb.md
- docs/components/image.md
- docs/components/imagegenerationstatus.md - docs/components/imagegenerationstatus.md
- docs/components/inputfidelity.md
- docs/components/inputimagemask.md
- docs/components/inputmodality.md - docs/components/inputmodality.md
- docs/components/inputtokensdetails.md - docs/components/inputtokensdetails.md
- docs/components/instructtype.md - docs/components/instructtype.md
- docs/components/internalserverresponseerrordata.md - docs/components/internalserverresponseerrordata.md
- docs/components/jsonschemaconfig.md - docs/components/jsonschemaconfig.md
- docs/components/listendpointsresponse.md - docs/components/listendpointsresponse.md
- docs/components/memorylimit.md - docs/components/logprob.md
- docs/components/message.md - docs/components/message.md
- docs/components/modality.md - docs/components/modality.md
- docs/components/model.md - docs/components/model.md
- docs/components/modelarchitecture.md - docs/components/modelarchitecture.md
- docs/components/modelarchitectureinstructtype.md - docs/components/modelarchitectureinstructtype.md
- docs/components/modelenum.md
- docs/components/modelgroup.md - docs/components/modelgroup.md
- docs/components/modelscountresponse.md - docs/components/modelscountresponse.md
- docs/components/modelscountresponsedata.md
- docs/components/modelslistresponse.md - docs/components/modelslistresponse.md
- docs/components/moderation.md
- docs/components/namedtoolchoice.md - docs/components/namedtoolchoice.md
- docs/components/namedtoolchoicefunction.md - docs/components/namedtoolchoicefunction.md
- docs/components/namedtoolchoicetype.md
- docs/components/never.md
- docs/components/notfoundresponseerrordata.md - docs/components/notfoundresponseerrordata.md
- docs/components/object.md
- docs/components/openairesponsesannotation.md - docs/components/openairesponsesannotation.md
- docs/components/openairesponsesincludable.md - docs/components/openairesponsesincludable.md
- docs/components/openairesponsesincompletedetails.md - docs/components/openairesponsesincompletedetails.md
@@ -209,11 +146,6 @@ generatedFiles:
- docs/components/openairesponsesinputfunctioncalloutput.md - docs/components/openairesponsesinputfunctioncalloutput.md
- docs/components/openairesponsesinputmessage1.md - docs/components/openairesponsesinputmessage1.md
- docs/components/openairesponsesinputmessage2.md - docs/components/openairesponsesinputmessage2.md
- docs/components/openairesponsesinputoutput1.md
- docs/components/openairesponsesinputoutput2.md
- docs/components/openairesponsesinputphasecommentary.md
- docs/components/openairesponsesinputphasefinalanswer.md
- docs/components/openairesponsesinputphaseunion.md
- docs/components/openairesponsesinputroleassistant.md - docs/components/openairesponsesinputroleassistant.md
- docs/components/openairesponsesinputroledeveloper1.md - docs/components/openairesponsesinputroledeveloper1.md
- docs/components/openairesponsesinputroledeveloper2.md - docs/components/openairesponsesinputroledeveloper2.md
@@ -246,21 +178,12 @@ generatedFiles:
- docs/components/openairesponsestoolchoicetypewebsearchpreview20250311.md - docs/components/openairesponsestoolchoicetypewebsearchpreview20250311.md
- docs/components/openairesponsestoolchoiceunion.md - docs/components/openairesponsestoolchoiceunion.md
- docs/components/openairesponsestruncation.md - docs/components/openairesponsestruncation.md
- docs/components/openresponsesapplypatchtool.md
- docs/components/openresponsesapplypatchtooltype.md
- docs/components/openresponsescodeinterpretertool.md
- docs/components/openresponsescomputertool.md
- docs/components/openresponsescomputertooltype.md
- docs/components/openresponsescustomtool.md
- docs/components/openresponseseasyinputmessage.md - docs/components/openresponseseasyinputmessage.md
- docs/components/openresponseseasyinputmessagecontentinputimage.md - docs/components/openresponseseasyinputmessagecontentinputimage.md
- docs/components/openresponseseasyinputmessagecontenttype.md - docs/components/openresponseseasyinputmessagecontenttype.md
- docs/components/openresponseseasyinputmessagecontentunion1.md - docs/components/openresponseseasyinputmessagecontentunion1.md
- docs/components/openresponseseasyinputmessagecontentunion2.md - docs/components/openresponseseasyinputmessagecontentunion2.md
- docs/components/openresponseseasyinputmessagedetail.md - docs/components/openresponseseasyinputmessagedetail.md
- docs/components/openresponseseasyinputmessagephasecommentary.md
- docs/components/openresponseseasyinputmessagephasefinalanswer.md
- docs/components/openresponseseasyinputmessagephaseunion.md
- docs/components/openresponseseasyinputmessageroleassistant.md - docs/components/openresponseseasyinputmessageroleassistant.md
- docs/components/openresponseseasyinputmessageroledeveloper.md - docs/components/openresponseseasyinputmessageroledeveloper.md
- docs/components/openresponseseasyinputmessagerolesystem.md - docs/components/openresponseseasyinputmessagerolesystem.md
@@ -269,15 +192,8 @@ generatedFiles:
- docs/components/openresponseseasyinputmessagetypemessage.md - docs/components/openresponseseasyinputmessagetypemessage.md
- docs/components/openresponseserrorevent.md - docs/components/openresponseserrorevent.md
- docs/components/openresponseserroreventtype.md - docs/components/openresponseserroreventtype.md
- docs/components/openresponsesfilesearchtool.md
- docs/components/openresponsesfilesearchtoolfilters.md
- docs/components/openresponsesfunctioncalloutput.md - docs/components/openresponsesfunctioncalloutput.md
- docs/components/openresponsesfunctioncalloutputdetail.md - docs/components/openresponsesfunctioncalloutputtype.md
- docs/components/openresponsesfunctioncalloutputoutputunion1.md
- docs/components/openresponsesfunctioncalloutputoutputunion2.md
- docs/components/openresponsesfunctioncalloutputtypefunctioncalloutput.md
- docs/components/openresponsesfunctionshelltool.md
- docs/components/openresponsesfunctionshelltooltype.md
- docs/components/openresponsesfunctiontoolcall.md - docs/components/openresponsesfunctiontoolcall.md
- docs/components/openresponsesfunctiontoolcalltype.md - docs/components/openresponsesfunctiontoolcalltype.md
- docs/components/openresponsesimagegencallcompleted.md - docs/components/openresponsesimagegencallcompleted.md
@@ -288,12 +204,8 @@ generatedFiles:
- docs/components/openresponsesimagegencallinprogresstype.md - docs/components/openresponsesimagegencallinprogresstype.md
- docs/components/openresponsesimagegencallpartialimage.md - docs/components/openresponsesimagegencallpartialimage.md
- docs/components/openresponsesimagegencallpartialimagetype.md - docs/components/openresponsesimagegencallpartialimagetype.md
- docs/components/openresponsesimagegenerationtool.md - docs/components/openresponsesinput.md
- docs/components/openresponsesimagegenerationtooltype.md - docs/components/openresponsesinput1.md
- docs/components/openresponsesinputcontent1.md
- docs/components/openresponsesinputcontent2.md
- docs/components/openresponsesinputformat.md
- docs/components/openresponsesinputmessage.md
- docs/components/openresponsesinputmessageitem.md - docs/components/openresponsesinputmessageitem.md
- docs/components/openresponsesinputmessageitemcontentinputimage.md - docs/components/openresponsesinputmessageitemcontentinputimage.md
- docs/components/openresponsesinputmessageitemcontenttype.md - docs/components/openresponsesinputmessageitemcontenttype.md
@@ -304,29 +216,8 @@ generatedFiles:
- docs/components/openresponsesinputmessageitemroleunion.md - docs/components/openresponsesinputmessageitemroleunion.md
- docs/components/openresponsesinputmessageitemroleuser.md - docs/components/openresponsesinputmessageitemroleuser.md
- docs/components/openresponsesinputmessageitemtypemessage.md - docs/components/openresponsesinputmessageitemtypemessage.md
- docs/components/openresponsesinputphasecommentary.md - docs/components/openresponseslogprobs.md
- docs/components/openresponsesinputphasefinalanswer.md
- docs/components/openresponsesinputphaseunion.md
- docs/components/openresponsesinputreasoning.md
- docs/components/openresponsesinputrole.md
- docs/components/openresponsesinputstatuscompleted1.md
- docs/components/openresponsesinputstatuscompleted2.md
- docs/components/openresponsesinputstatusincomplete1.md
- docs/components/openresponsesinputstatusincomplete2.md
- docs/components/openresponsesinputstatusinprogress1.md
- docs/components/openresponsesinputstatusinprogress2.md
- docs/components/openresponsesinputstatusunion1.md
- docs/components/openresponsesinputstatusunion2.md
- docs/components/openresponsesinputtypemessage.md
- docs/components/openresponsesinputtypereasoning.md
- docs/components/openresponsesinputunion.md
- docs/components/openresponsesinputunion1.md
- docs/components/openresponseslocalshelltool.md
- docs/components/openresponseslocalshelltooltype.md
- docs/components/openresponsesmcptool.md
- docs/components/openresponsesmcptooltype.md
- docs/components/openresponsesnonstreamingresponse.md - docs/components/openresponsesnonstreamingresponse.md
- docs/components/openresponsesnonstreamingresponseobject.md
- docs/components/openresponsesnonstreamingresponsetoolfunction.md - docs/components/openresponsesnonstreamingresponsetoolfunction.md
- docs/components/openresponsesnonstreamingresponsetoolunion.md - docs/components/openresponsesnonstreamingresponsetoolunion.md
- docs/components/openresponsesnonstreamingresponsetype.md - docs/components/openresponsesnonstreamingresponsetype.md
@@ -349,33 +240,18 @@ generatedFiles:
- docs/components/openresponsesreasoningsummarytextdoneeventtype.md - docs/components/openresponsesreasoningsummarytextdoneeventtype.md
- docs/components/openresponsesreasoningtype.md - docs/components/openresponsesreasoningtype.md
- docs/components/openresponsesrequest.md - docs/components/openresponsesrequest.md
- docs/components/openresponsesrequestidautorouter.md
- docs/components/openresponsesrequestidfileparser.md
- docs/components/openresponsesrequestidmoderation.md
- docs/components/openresponsesrequestidresponsehealing.md
- docs/components/openresponsesrequestidweb.md
- docs/components/openresponsesrequestignore.md - docs/components/openresponsesrequestignore.md
- docs/components/openresponsesrequestimageconfig.md - docs/components/openresponsesrequestimageconfig.md
- docs/components/openresponsesrequestmaxprice.md - docs/components/openresponsesrequestmaxprice.md
- docs/components/openresponsesrequestonly.md - docs/components/openresponsesrequestonly.md
- docs/components/openresponsesrequestorder.md - docs/components/openresponsesrequestorder.md
- docs/components/openresponsesrequestpluginautorouter.md
- docs/components/openresponsesrequestpluginfileparser.md
- docs/components/openresponsesrequestpluginmoderation.md
- docs/components/openresponsesrequestpluginresponsehealing.md
- docs/components/openresponsesrequestpluginunion.md
- docs/components/openresponsesrequestpluginweb.md
- docs/components/openresponsesrequestprovider.md
- docs/components/openresponsesrequestsort.md - docs/components/openresponsesrequestsort.md
- docs/components/openresponsesrequesttoolfunction.md - docs/components/openresponsesrequesttoolfunction.md
- docs/components/openresponsesrequesttoolunion.md - docs/components/openresponsesrequesttoolunion.md
- docs/components/openresponsesrequesttrace.md
- docs/components/openresponsesrequesttype.md - docs/components/openresponsesrequesttype.md
- docs/components/openresponsesresponsetext.md - docs/components/openresponsesresponsetext.md
- docs/components/openresponsesresponsetextverbosity.md - docs/components/openresponsesresponsetextverbosity.md
- docs/components/openresponsesstreamevent.md - docs/components/openresponsesstreamevent.md
- docs/components/openresponsesstreameventlogprob1.md
- docs/components/openresponsesstreameventlogprob2.md
- docs/components/openresponsesstreameventresponsecompleted.md - docs/components/openresponsesstreameventresponsecompleted.md
- docs/components/openresponsesstreameventresponsecontentpartadded.md - docs/components/openresponsesstreameventresponsecontentpartadded.md
- docs/components/openresponsesstreameventresponsecontentpartdone.md - docs/components/openresponsesstreameventresponsecontentpartdone.md
@@ -393,8 +269,7 @@ generatedFiles:
- docs/components/openresponsesstreameventresponsereasoningsummarypartdone.md - docs/components/openresponsesstreameventresponsereasoningsummarypartdone.md
- docs/components/openresponsesstreameventresponserefusaldelta.md - docs/components/openresponsesstreameventresponserefusaldelta.md
- docs/components/openresponsesstreameventresponserefusaldone.md - docs/components/openresponsesstreameventresponserefusaldone.md
- docs/components/openresponsesstreameventtoplogprob1.md - docs/components/openresponsestoplogprobs.md
- docs/components/openresponsesstreameventtoplogprob2.md
- docs/components/openresponsesusage.md - docs/components/openresponsesusage.md
- docs/components/openresponseswebsearch20250826tool.md - docs/components/openresponseswebsearch20250826tool.md
- docs/components/openresponseswebsearch20250826toolfilters.md - docs/components/openresponseswebsearch20250826toolfilters.md
@@ -406,15 +281,10 @@ generatedFiles:
- docs/components/openresponseswebsearchtool.md - docs/components/openresponseswebsearchtool.md
- docs/components/openresponseswebsearchtoolfilters.md - docs/components/openresponseswebsearchtoolfilters.md
- docs/components/openresponseswebsearchtooltype.md - docs/components/openresponseswebsearchtooltype.md
- docs/components/outputformat.md
- docs/components/outputinputimage.md
- docs/components/outputitemimagegenerationcall.md - docs/components/outputitemimagegenerationcall.md
- docs/components/outputitemimagegenerationcalltype.md - docs/components/outputitemimagegenerationcalltype.md
- docs/components/outputmessage.md - docs/components/outputmessage.md
- docs/components/outputmessagecontent.md - docs/components/outputmessagecontent.md
- docs/components/outputmessagephasecommentary.md
- docs/components/outputmessagephasefinalanswer.md
- docs/components/outputmessagephaseunion.md
- docs/components/outputmessagerole.md - docs/components/outputmessagerole.md
- docs/components/outputmessagestatuscompleted.md - docs/components/outputmessagestatuscompleted.md
- docs/components/outputmessagestatusincomplete.md - docs/components/outputmessagestatusincomplete.md
@@ -423,27 +293,35 @@ generatedFiles:
- docs/components/outputmessagetype.md - docs/components/outputmessagetype.md
- docs/components/outputmodality.md - docs/components/outputmodality.md
- docs/components/outputtokensdetails.md - docs/components/outputtokensdetails.md
- docs/components/outputtype.md
- docs/components/parameter.md - docs/components/parameter.md
- docs/components/part1.md - docs/components/part1.md
- docs/components/part2.md - docs/components/part2.md
- docs/components/partition.md - docs/components/partition.md
- docs/components/payloadtoolargeresponseerrordata.md - docs/components/payloadtoolargeresponseerrordata.md
- docs/components/paymentrequiredresponseerrordata.md - docs/components/paymentrequiredresponseerrordata.md
- docs/components/pdf.md
- docs/components/pdfengine.md
- docs/components/pdfparserengine.md - docs/components/pdfparserengine.md
- docs/components/pdfparseroptions.md - docs/components/pdfparseroptions.md
- docs/components/percentilelatencycutoffs.md - docs/components/percentilelatencycutoffs.md
- docs/components/percentilestats.md - docs/components/percentilestats.md
- docs/components/percentilethroughputcutoffs.md - docs/components/percentilethroughputcutoffs.md
- docs/components/perrequestlimits.md - docs/components/perrequestlimits.md
- docs/components/plugin.md
- docs/components/pluginautorouter.md
- docs/components/pluginfileparser.md
- docs/components/pluginmoderation.md
- docs/components/pluginresponsehealing.md
- docs/components/pluginweb.md
- docs/components/preferredmaxlatency.md - docs/components/preferredmaxlatency.md
- docs/components/preferredminthroughput.md - docs/components/preferredminthroughput.md
- docs/components/pricing.md - docs/components/pricing.md
- docs/components/prompt.md
- docs/components/prompttokensdetails.md - docs/components/prompttokensdetails.md
- docs/components/provider.md
- docs/components/providername.md - docs/components/providername.md
- docs/components/provideroverloadedresponseerrordata.md - docs/components/provideroverloadedresponseerrordata.md
- docs/components/providerpreferences.md - docs/components/providerpreferences.md
- docs/components/providerpreferencesby.md
- docs/components/providerpreferencesignore.md - docs/components/providerpreferencesignore.md
- docs/components/providerpreferencesmaxprice.md - docs/components/providerpreferencesmaxprice.md
- docs/components/providerpreferencesonly.md - docs/components/providerpreferencesonly.md
@@ -451,52 +329,31 @@ generatedFiles:
- docs/components/providerpreferencespartition.md - docs/components/providerpreferencespartition.md
- docs/components/providerpreferencesprovidersort.md - docs/components/providerpreferencesprovidersort.md
- docs/components/providerpreferencesprovidersortconfig.md - docs/components/providerpreferencesprovidersortconfig.md
- docs/components/providerpreferencesprovidersortconfigenum.md
- docs/components/providerpreferencesprovidersortconfigunion.md
- docs/components/providerpreferencessortenum.md
- docs/components/providerpreferencessortunion.md - docs/components/providerpreferencessortunion.md
- docs/components/providersort.md - docs/components/providersort.md
- docs/components/providersortconfig.md - docs/components/providersortconfig.md
- docs/components/providersortconfigenum.md
- docs/components/providersortconfigunion.md
- docs/components/providersortunion.md
- docs/components/publicendpoint.md - docs/components/publicendpoint.md
- docs/components/publicendpointquantization.md - docs/components/publicendpointquantization.md
- docs/components/publicpricing.md - docs/components/publicpricing.md
- docs/components/quality.md
- docs/components/quantization.md - docs/components/quantization.md
- docs/components/ranker.md
- docs/components/rankingoptions.md
- docs/components/reason.md - docs/components/reason.md
- docs/components/reasoning.md - docs/components/reasoning.md
- docs/components/reasoningdetailencrypted.md
- docs/components/reasoningdetailencryptedformat.md
- docs/components/reasoningdetailencryptedtype.md
- docs/components/reasoningdetailsummary.md
- docs/components/reasoningdetailsummaryformat.md
- docs/components/reasoningdetailsummarytype.md
- docs/components/reasoningdetailtext.md
- docs/components/reasoningdetailtextformat.md
- docs/components/reasoningdetailtexttype.md
- docs/components/reasoningdetailunion.md
- docs/components/reasoningsummarytext.md - docs/components/reasoningsummarytext.md
- docs/components/reasoningsummarytexttype.md - docs/components/reasoningsummarytexttype.md
- docs/components/reasoningsummaryverbosity.md - docs/components/reasoningsummaryverbosity.md
- docs/components/reasoningtextcontent.md - docs/components/reasoningtextcontent.md
- docs/components/reasoningtextcontenttype.md - docs/components/reasoningtextcontenttype.md
- docs/components/requesttimeoutresponseerrordata.md - docs/components/requesttimeoutresponseerrordata.md
- docs/components/requireapproval.md
- docs/components/requireapprovalalways.md
- docs/components/requireapprovalnever.md
- docs/components/responseformat.md - docs/components/responseformat.md
- docs/components/responseformatjsonobject.md - docs/components/responseformatjsonobject.md
- docs/components/responseformatjsonobjecttype.md
- docs/components/responseformatjsonschema.md - docs/components/responseformatjsonschema.md
- docs/components/responseformatjsonschematype.md - docs/components/responseformatpython.md
- docs/components/responseformattext.md - docs/components/responseformattext.md
- docs/components/responseformattextconfig.md - docs/components/responseformattextconfig.md
- docs/components/responseformattextgrammar.md - docs/components/responseformattextgrammar.md
- docs/components/responseformattextgrammartype.md
- docs/components/responseformattextpython.md
- docs/components/responseformattextpythontype.md
- docs/components/responseformattexttype.md
- docs/components/responseinputaudio.md - docs/components/responseinputaudio.md
- docs/components/responseinputaudioformat.md - docs/components/responseinputaudioformat.md
- docs/components/responseinputaudioinputaudio.md - docs/components/responseinputaudioinputaudio.md
@@ -511,10 +368,11 @@ generatedFiles:
- docs/components/responseinputvideo.md - docs/components/responseinputvideo.md
- docs/components/responseinputvideotype.md - docs/components/responseinputvideotype.md
- docs/components/responseoutputtext.md - docs/components/responseoutputtext.md
- docs/components/responseoutputtextlogprob.md
- docs/components/responseoutputtexttoplogprob.md - docs/components/responseoutputtexttoplogprob.md
- docs/components/responseoutputtexttype.md - docs/components/responseoutputtexttype.md
- docs/components/responseserrorfield.md - docs/components/responseserrorfield.md
- docs/components/responsesformatjsonobject.md
- docs/components/responsesformatjsonobjecttype.md
- docs/components/responsesformattext.md - docs/components/responsesformattext.md
- docs/components/responsesformattextjsonschemaconfig.md - docs/components/responsesformattextjsonschemaconfig.md
- docs/components/responsesformattextjsonschemaconfigtype.md - docs/components/responsesformattextjsonschemaconfigtype.md
@@ -539,9 +397,6 @@ generatedFiles:
- docs/components/responsesoutputitemreasoningtype.md - docs/components/responsesoutputitemreasoningtype.md
- docs/components/responsesoutputmessage.md - docs/components/responsesoutputmessage.md
- docs/components/responsesoutputmessagecontent.md - docs/components/responsesoutputmessagecontent.md
- docs/components/responsesoutputmessagephasecommentary.md
- docs/components/responsesoutputmessagephasefinalanswer.md
- docs/components/responsesoutputmessagephaseunion.md
- docs/components/responsesoutputmessagerole.md - docs/components/responsesoutputmessagerole.md
- docs/components/responsesoutputmessagestatuscompleted.md - docs/components/responsesoutputmessagestatuscompleted.md
- docs/components/responsesoutputmessagestatusincomplete.md - docs/components/responsesoutputmessagestatusincomplete.md
@@ -551,41 +406,50 @@ generatedFiles:
- docs/components/responsesoutputmodality.md - docs/components/responsesoutputmodality.md
- docs/components/responsessearchcontextsize.md - docs/components/responsessearchcontextsize.md
- docs/components/responseswebsearchcalloutput.md - docs/components/responseswebsearchcalloutput.md
- docs/components/responseswebsearchcalloutputtype.md
- docs/components/responseswebsearchuserlocation.md - docs/components/responseswebsearchuserlocation.md
- docs/components/responseswebsearchuserlocationtype.md - docs/components/responseswebsearchuserlocationtype.md
- docs/components/responsetextconfig.md - docs/components/responsetextconfig.md
- docs/components/responsetextconfigverbosity.md - docs/components/responsetextconfigverbosity.md
- docs/components/route.md
- docs/components/schema0.md
- docs/components/schema10.md
- docs/components/schema14.md
- docs/components/schema15.md
- docs/components/schema15union.md
- docs/components/schema17.md
- docs/components/schema17autorouter.md
- docs/components/schema17fileparser.md
- docs/components/schema17moderation.md
- docs/components/schema17responsehealing.md
- docs/components/schema17web.md
- docs/components/schema19.md
- docs/components/schema19reasoningencrypted.md
- docs/components/schema19reasoningsummary.md
- docs/components/schema19reasoningtext.md
- docs/components/schema21.md
- docs/components/schema3.md
- docs/components/schema5.md
- docs/components/schema5enum.md
- docs/components/schema8.md
- docs/components/security.md - docs/components/security.md
- docs/components/servicetier.md - docs/components/servicetier.md
- docs/components/serviceunavailableresponseerrordata.md - docs/components/serviceunavailableresponseerrordata.md
- docs/components/size.md - docs/components/sortenum.md
- docs/components/source.md
- docs/components/stop.md - docs/components/stop.md
- docs/components/syntax.md
- docs/components/systemmessage.md - docs/components/systemmessage.md
- docs/components/systemmessagecontent.md - docs/components/systemmessagecontent.md
- docs/components/systemmessagerole.md
- docs/components/tokenizer.md - docs/components/tokenizer.md
- docs/components/toolcallstatus.md - docs/components/toolcallstatus.md
- docs/components/toolchoiceoption.md
- docs/components/toolchoiceoptionauto.md
- docs/components/toolchoiceoptionnone.md
- docs/components/toolchoiceoptionrequired.md
- docs/components/tooldefinitionjson.md - docs/components/tooldefinitionjson.md
- docs/components/tooldefinitionjsonfunction.md - docs/components/tooldefinitionjsonfunction.md
- docs/components/tooldefinitionjsontype.md
- docs/components/toolresponsemessage.md - docs/components/toolresponsemessage.md
- docs/components/toolresponsemessagecontent.md - docs/components/toolresponsemessagecontent.md
- docs/components/toolresponsemessagerole.md
- docs/components/toomanyrequestsresponseerrordata.md - docs/components/toomanyrequestsresponseerrordata.md
- docs/components/topproviderinfo.md - docs/components/topproviderinfo.md
- docs/components/truncation.md - docs/components/truncation.md
- docs/components/ttl.md
- docs/components/type.md - docs/components/type.md
- docs/components/typecodeinterpreter.md
- docs/components/typecustom.md
- docs/components/typefilesearch.md
- docs/components/typefindinpage.md
- docs/components/typeopenpage.md
- docs/components/typeresponsecompleted.md - docs/components/typeresponsecompleted.md
- docs/components/typeresponsecontentpartadded.md - docs/components/typeresponsecontentpartadded.md
- docs/components/typeresponsecontentpartdone.md - docs/components/typeresponsecontentpartdone.md
@@ -603,26 +467,22 @@ generatedFiles:
- docs/components/typeresponsereasoningsummarypartdone.md - docs/components/typeresponsereasoningsummarypartdone.md
- docs/components/typeresponserefusaldelta.md - docs/components/typeresponserefusaldelta.md
- docs/components/typeresponserefusaldone.md - docs/components/typeresponserefusaldone.md
- docs/components/typesearch.md
- docs/components/typeurl.md
- docs/components/typewebsearchcall.md
- docs/components/unauthorizedresponseerrordata.md - docs/components/unauthorizedresponseerrordata.md
- docs/components/unprocessableentityresponseerrordata.md - docs/components/unprocessableentityresponseerrordata.md
- docs/components/urlcitation.md - docs/components/urlcitation.md
- docs/components/urlcitationtype.md - docs/components/urlcitationtype.md
- docs/components/usermessage.md - docs/components/usermessage.md
- docs/components/usermessagecontent.md - docs/components/usermessagecontent.md
- docs/components/usermessagerole.md
- docs/components/value1.md
- docs/components/value2.md
- docs/components/variables.md - docs/components/variables.md
- docs/components/videoinput.md - docs/components/videourl1.md
- docs/components/videourl2.md
- docs/components/websearchengine.md - docs/components/websearchengine.md
- docs/components/websearchpreviewtooluserlocation.md - docs/components/websearchpreviewtooluserlocation.md
- docs/components/websearchpreviewtooluserlocationtype.md - docs/components/websearchpreviewtooluserlocationtype.md
- docs/components/websearchstatus.md - docs/components/websearchstatus.md
- docs/errors/badgatewayresponseerror.md - docs/errors/badgatewayresponseerror.md
- docs/errors/badrequestresponseerror.md - docs/errors/badrequestresponseerror.md
- docs/errors/chaterror.md
- docs/errors/edgenetworktimeoutresponseerror.md - docs/errors/edgenetworktimeoutresponseerror.md
- docs/errors/forbiddenresponseerror.md - docs/errors/forbiddenresponseerror.md
- docs/errors/internalserverresponseerror.md - docs/errors/internalserverresponseerror.md
@@ -638,19 +498,15 @@ generatedFiles:
- docs/models/internal/globals.md - docs/models/internal/globals.md
- docs/models/utils/retryconfig.md - docs/models/utils/retryconfig.md
- docs/operations/apitype.md - docs/operations/apitype.md
- docs/operations/bulkassignkeystoguardrailglobals.md
- docs/operations/bulkassignkeystoguardrailrequest.md - docs/operations/bulkassignkeystoguardrailrequest.md
- docs/operations/bulkassignkeystoguardrailrequestbody.md - docs/operations/bulkassignkeystoguardrailrequestbody.md
- docs/operations/bulkassignkeystoguardrailresponse.md - docs/operations/bulkassignkeystoguardrailresponse.md
- docs/operations/bulkassignmemberstoguardrailglobals.md
- docs/operations/bulkassignmemberstoguardrailrequest.md - docs/operations/bulkassignmemberstoguardrailrequest.md
- docs/operations/bulkassignmemberstoguardrailrequestbody.md - docs/operations/bulkassignmemberstoguardrailrequestbody.md
- docs/operations/bulkassignmemberstoguardrailresponse.md - docs/operations/bulkassignmemberstoguardrailresponse.md
- docs/operations/bulkunassignkeysfromguardrailglobals.md
- docs/operations/bulkunassignkeysfromguardrailrequest.md - docs/operations/bulkunassignkeysfromguardrailrequest.md
- docs/operations/bulkunassignkeysfromguardrailrequestbody.md - docs/operations/bulkunassignkeysfromguardrailrequestbody.md
- docs/operations/bulkunassignkeysfromguardrailresponse.md - docs/operations/bulkunassignkeysfromguardrailresponse.md
- docs/operations/bulkunassignmembersfromguardrailglobals.md
- docs/operations/bulkunassignmembersfromguardrailrequest.md - docs/operations/bulkunassignmembersfromguardrailrequest.md
- docs/operations/bulkunassignmembersfromguardrailrequestbody.md - docs/operations/bulkunassignmembersfromguardrailrequestbody.md
- docs/operations/bulkunassignmembersfromguardrailresponse.md - docs/operations/bulkunassignmembersfromguardrailresponse.md
@@ -661,119 +517,77 @@ generatedFiles:
- docs/operations/contenttext.md - docs/operations/contenttext.md
- docs/operations/createauthkeyscodecodechallengemethod.md - docs/operations/createauthkeyscodecodechallengemethod.md
- docs/operations/createauthkeyscodedata.md - docs/operations/createauthkeyscodedata.md
- docs/operations/createauthkeyscodeglobals.md
- docs/operations/createauthkeyscoderequest.md - docs/operations/createauthkeyscoderequest.md
- docs/operations/createauthkeyscoderequestbody.md
- docs/operations/createauthkeyscoderesponse.md - docs/operations/createauthkeyscoderesponse.md
- docs/operations/createcoinbasechargedata.md - docs/operations/createcoinbasechargedata.md
- docs/operations/createcoinbasechargeglobals.md
- docs/operations/createcoinbasechargerequest.md
- docs/operations/createcoinbasechargeresponse.md - docs/operations/createcoinbasechargeresponse.md
- docs/operations/createcoinbasechargesecurity.md - docs/operations/createcoinbasechargesecurity.md
- docs/operations/createembeddingsdata.md - docs/operations/createembeddingsdata.md
- docs/operations/createembeddingsglobals.md
- docs/operations/createembeddingsrequest.md - docs/operations/createembeddingsrequest.md
- docs/operations/createembeddingsrequestbody.md
- docs/operations/createembeddingsresponse.md - docs/operations/createembeddingsresponse.md
- docs/operations/createembeddingsresponsebody.md - docs/operations/createembeddingsresponsebody.md
- docs/operations/createguardraildata.md - docs/operations/createguardraildata.md
- docs/operations/createguardrailglobals.md
- docs/operations/createguardrailrequest.md - docs/operations/createguardrailrequest.md
- docs/operations/createguardrailrequestbody.md
- docs/operations/createguardrailresetintervalrequest.md - docs/operations/createguardrailresetintervalrequest.md
- docs/operations/createguardrailresetintervalresponse.md - docs/operations/createguardrailresetintervalresponse.md
- docs/operations/createguardrailresponse.md - docs/operations/createguardrailresponse.md
- docs/operations/createkeysdata.md - docs/operations/createkeysdata.md
- docs/operations/createkeysglobals.md
- docs/operations/createkeyslimitreset.md - docs/operations/createkeyslimitreset.md
- docs/operations/createkeysrequest.md - docs/operations/createkeysrequest.md
- docs/operations/createkeysrequestbody.md
- docs/operations/createkeysresponse.md - docs/operations/createkeysresponse.md
- docs/operations/createresponsesglobals.md
- docs/operations/createresponsesrequest.md
- docs/operations/createresponsesresponse.md - docs/operations/createresponsesresponse.md
- docs/operations/createresponsesresponsebody.md - docs/operations/createresponsesresponsebody.md
- docs/operations/deleteguardrailglobals.md
- docs/operations/deleteguardrailrequest.md - docs/operations/deleteguardrailrequest.md
- docs/operations/deleteguardrailresponse.md - docs/operations/deleteguardrailresponse.md
- docs/operations/deletekeysglobals.md
- docs/operations/deletekeysrequest.md - docs/operations/deletekeysrequest.md
- docs/operations/deletekeysresponse.md - docs/operations/deletekeysresponse.md
- docs/operations/embedding.md - docs/operations/embedding.md
- docs/operations/encodingformat.md - docs/operations/encodingformat.md
- docs/operations/exchangeauthcodeforapikeycodechallengemethod.md - docs/operations/exchangeauthcodeforapikeycodechallengemethod.md
- docs/operations/exchangeauthcodeforapikeyglobals.md
- docs/operations/exchangeauthcodeforapikeyrequest.md - docs/operations/exchangeauthcodeforapikeyrequest.md
- docs/operations/exchangeauthcodeforapikeyrequestbody.md
- docs/operations/exchangeauthcodeforapikeyresponse.md - docs/operations/exchangeauthcodeforapikeyresponse.md
- docs/operations/getcreditsdata.md - docs/operations/getcreditsdata.md
- docs/operations/getcreditsglobals.md
- docs/operations/getcreditsrequest.md
- docs/operations/getcreditsresponse.md - docs/operations/getcreditsresponse.md
- docs/operations/getcurrentkeydata.md - docs/operations/getcurrentkeydata.md
- docs/operations/getcurrentkeyglobals.md
- docs/operations/getcurrentkeyrequest.md
- docs/operations/getcurrentkeyresponse.md - docs/operations/getcurrentkeyresponse.md
- docs/operations/getgenerationdata.md - docs/operations/getgenerationdata.md
- docs/operations/getgenerationglobals.md
- docs/operations/getgenerationrequest.md - docs/operations/getgenerationrequest.md
- docs/operations/getgenerationresponse.md - docs/operations/getgenerationresponse.md
- docs/operations/getguardraildata.md - docs/operations/getguardraildata.md
- docs/operations/getguardrailglobals.md
- docs/operations/getguardrailrequest.md - docs/operations/getguardrailrequest.md
- docs/operations/getguardrailresetinterval.md - docs/operations/getguardrailresetinterval.md
- docs/operations/getguardrailresponse.md - docs/operations/getguardrailresponse.md
- docs/operations/getkeydata.md - docs/operations/getkeydata.md
- docs/operations/getkeyglobals.md
- docs/operations/getkeyrequest.md - docs/operations/getkeyrequest.md
- docs/operations/getkeyresponse.md - docs/operations/getkeyresponse.md
- docs/operations/getmodelsglobals.md
- docs/operations/getmodelsrequest.md - docs/operations/getmodelsrequest.md
- docs/operations/getuseractivityglobals.md
- docs/operations/getuseractivityrequest.md - docs/operations/getuseractivityrequest.md
- docs/operations/getuseractivityresponse.md - docs/operations/getuseractivityresponse.md
- docs/operations/imageurl.md - docs/operations/imageurl.md
- docs/operations/input.md - docs/operations/input.md
- docs/operations/inputunion.md - docs/operations/inputunion.md
- docs/operations/listdata.md - docs/operations/listdata.md
- docs/operations/listembeddingsmodelsglobals.md
- docs/operations/listembeddingsmodelsrequest.md
- docs/operations/listendpointsglobals.md
- docs/operations/listendpointsrequest.md - docs/operations/listendpointsrequest.md
- docs/operations/listendpointsresponse.md - docs/operations/listendpointsresponse.md
- docs/operations/listendpointszdrglobals.md
- docs/operations/listendpointszdrrequest.md
- docs/operations/listendpointszdrresponse.md - docs/operations/listendpointszdrresponse.md
- docs/operations/listglobals.md
- docs/operations/listguardrailkeyassignmentsdata.md - docs/operations/listguardrailkeyassignmentsdata.md
- docs/operations/listguardrailkeyassignmentsglobals.md
- docs/operations/listguardrailkeyassignmentsrequest.md - docs/operations/listguardrailkeyassignmentsrequest.md
- docs/operations/listguardrailkeyassignmentsresponse.md - docs/operations/listguardrailkeyassignmentsresponse.md
- docs/operations/listguardrailmemberassignmentsdata.md - docs/operations/listguardrailmemberassignmentsdata.md
- docs/operations/listguardrailmemberassignmentsglobals.md
- docs/operations/listguardrailmemberassignmentsrequest.md - docs/operations/listguardrailmemberassignmentsrequest.md
- docs/operations/listguardrailmemberassignmentsresponse.md - docs/operations/listguardrailmemberassignmentsresponse.md
- docs/operations/listguardrailsdata.md - docs/operations/listguardrailsdata.md
- docs/operations/listguardrailsglobals.md
- docs/operations/listguardrailsrequest.md - docs/operations/listguardrailsrequest.md
- docs/operations/listguardrailsresetinterval.md - docs/operations/listguardrailsresetinterval.md
- docs/operations/listguardrailsresponse.md - docs/operations/listguardrailsresponse.md
- docs/operations/listkeyassignmentsdata.md - docs/operations/listkeyassignmentsdata.md
- docs/operations/listkeyassignmentsglobals.md
- docs/operations/listkeyassignmentsrequest.md - docs/operations/listkeyassignmentsrequest.md
- docs/operations/listkeyassignmentsresponse.md - docs/operations/listkeyassignmentsresponse.md
- docs/operations/listmemberassignmentsdata.md - docs/operations/listmemberassignmentsdata.md
- docs/operations/listmemberassignmentsglobals.md
- docs/operations/listmemberassignmentsrequest.md - docs/operations/listmemberassignmentsrequest.md
- docs/operations/listmemberassignmentsresponse.md - docs/operations/listmemberassignmentsresponse.md
- docs/operations/listmodelscountglobals.md
- docs/operations/listmodelscountrequest.md
- docs/operations/listmodelsuserglobals.md
- docs/operations/listmodelsuserrequest.md
- docs/operations/listmodelsusersecurity.md - docs/operations/listmodelsusersecurity.md
- docs/operations/listprovidersdata.md - docs/operations/listprovidersdata.md
- docs/operations/listprovidersglobals.md
- docs/operations/listprovidersrequest.md
- docs/operations/listprovidersresponse.md - docs/operations/listprovidersresponse.md
- docs/operations/listrequest.md - docs/operations/listrequest.md
- docs/operations/listresponse.md - docs/operations/listresponse.md
@@ -783,28 +597,22 @@ generatedFiles:
- docs/operations/providername.md - docs/operations/providername.md
- docs/operations/providerresponse.md - docs/operations/providerresponse.md
- docs/operations/ratelimit.md - docs/operations/ratelimit.md
- docs/operations/sendchatcompletionrequestglobals.md
- docs/operations/sendchatcompletionrequestrequest.md
- docs/operations/sendchatcompletionrequestresponse.md - docs/operations/sendchatcompletionrequestresponse.md
- docs/operations/sendchatcompletionrequestresponsebody.md
- docs/operations/transferintent.md - docs/operations/transferintent.md
- docs/operations/typeimageurl.md - docs/operations/typeimageurl.md
- docs/operations/typetext.md - docs/operations/typetext.md
- docs/operations/updateguardraildata.md - docs/operations/updateguardraildata.md
- docs/operations/updateguardrailglobals.md
- docs/operations/updateguardrailrequest.md - docs/operations/updateguardrailrequest.md
- docs/operations/updateguardrailrequestbody.md - docs/operations/updateguardrailrequestbody.md
- docs/operations/updateguardrailresetintervalrequest.md - docs/operations/updateguardrailresetintervalrequest.md
- docs/operations/updateguardrailresetintervalresponse.md - docs/operations/updateguardrailresetintervalresponse.md
- docs/operations/updateguardrailresponse.md - docs/operations/updateguardrailresponse.md
- docs/operations/updatekeysdata.md - docs/operations/updatekeysdata.md
- docs/operations/updatekeysglobals.md
- docs/operations/updatekeyslimitreset.md - docs/operations/updatekeyslimitreset.md
- docs/operations/updatekeysrequest.md - docs/operations/updatekeysrequest.md
- docs/operations/updatekeysrequestbody.md - docs/operations/updatekeysrequestbody.md
- docs/operations/updatekeysresponse.md - docs/operations/updatekeysresponse.md
- docs/operations/usage.md - docs/operations/usage.md
- docs/operations/usagelimittype.md
- docs/operations/web3data.md - docs/operations/web3data.md
- docs/sdks/analytics/README.md - docs/sdks/analytics/README.md
- docs/sdks/apikeys/README.md - docs/sdks/apikeys/README.md
@@ -833,23 +641,25 @@ generatedFiles:
- src/openrouter/beta.py - src/openrouter/beta.py
- src/openrouter/chat.py - src/openrouter/chat.py
- src/openrouter/components/__init__.py - src/openrouter/components/__init__.py
- src/openrouter/components/_schema10.py
- src/openrouter/components/_schema14.py
- src/openrouter/components/_schema17.py
- src/openrouter/components/_schema19.py
- src/openrouter/components/_schema5.py
- src/openrouter/components/activityitem.py - src/openrouter/components/activityitem.py
- src/openrouter/components/assistantmessage.py - src/openrouter/components/assistantmessage.py
- src/openrouter/components/assistantmessageimages.py
- src/openrouter/components/badgatewayresponseerrordata.py - src/openrouter/components/badgatewayresponseerrordata.py
- src/openrouter/components/badrequestresponseerrordata.py - src/openrouter/components/badrequestresponseerrordata.py
- src/openrouter/components/chatcompletionaudiooutput.py
- src/openrouter/components/chatcompletionfinishreason.py - src/openrouter/components/chatcompletionfinishreason.py
- src/openrouter/components/chaterror.py
- src/openrouter/components/chatgenerationparams.py - src/openrouter/components/chatgenerationparams.py
- src/openrouter/components/chatgenerationtokenusage.py - src/openrouter/components/chatgenerationtokenusage.py
- src/openrouter/components/chatmessagecontentitem.py - src/openrouter/components/chatmessagecontentitem.py
- src/openrouter/components/chatmessagecontentitemaudio.py - src/openrouter/components/chatmessagecontentitemaudio.py
- src/openrouter/components/chatmessagecontentitemcachecontrol.py - src/openrouter/components/chatmessagecontentitemcachecontrol.py
- src/openrouter/components/chatmessagecontentitemfile.py
- src/openrouter/components/chatmessagecontentitemimage.py - src/openrouter/components/chatmessagecontentitemimage.py
- src/openrouter/components/chatmessagecontentitemtext.py - src/openrouter/components/chatmessagecontentitemtext.py
- src/openrouter/components/chatmessagecontentitemvideo.py - src/openrouter/components/chatmessagecontentitemvideo.py
- src/openrouter/components/chatmessagecontentitemvideolegacy.py
- src/openrouter/components/chatmessagetokenlogprob.py - src/openrouter/components/chatmessagetokenlogprob.py
- src/openrouter/components/chatmessagetokenlogprobs.py - src/openrouter/components/chatmessagetokenlogprobs.py
- src/openrouter/components/chatmessagetoolcall.py - src/openrouter/components/chatmessagetoolcall.py
@@ -860,10 +670,8 @@ generatedFiles:
- src/openrouter/components/chatstreamingmessagetoolcall.py - src/openrouter/components/chatstreamingmessagetoolcall.py
- src/openrouter/components/chatstreamingresponsechunk.py - src/openrouter/components/chatstreamingresponsechunk.py
- src/openrouter/components/chatstreamoptions.py - src/openrouter/components/chatstreamoptions.py
- src/openrouter/components/compoundfilter.py
- src/openrouter/components/createchargerequest.py - src/openrouter/components/createchargerequest.py
- src/openrouter/components/datacollection.py - src/openrouter/components/datacollection.py
- src/openrouter/components/debugoptions.py
- src/openrouter/components/defaultparameters.py - src/openrouter/components/defaultparameters.py
- src/openrouter/components/developermessage.py - src/openrouter/components/developermessage.py
- src/openrouter/components/edgenetworktimeoutresponseerrordata.py - src/openrouter/components/edgenetworktimeoutresponseerrordata.py
@@ -897,25 +705,17 @@ generatedFiles:
- src/openrouter/components/openairesponsesservicetier.py - src/openrouter/components/openairesponsesservicetier.py
- src/openrouter/components/openairesponsestoolchoice_union.py - src/openrouter/components/openairesponsestoolchoice_union.py
- src/openrouter/components/openairesponsestruncation.py - src/openrouter/components/openairesponsestruncation.py
- src/openrouter/components/openresponsesapplypatchtool.py
- src/openrouter/components/openresponsescodeinterpretertool.py
- src/openrouter/components/openresponsescomputertool.py
- src/openrouter/components/openresponsescustomtool.py
- src/openrouter/components/openresponseseasyinputmessage.py - src/openrouter/components/openresponseseasyinputmessage.py
- src/openrouter/components/openresponseserrorevent.py - src/openrouter/components/openresponseserrorevent.py
- src/openrouter/components/openresponsesfilesearchtool.py
- src/openrouter/components/openresponsesfunctioncalloutput.py - src/openrouter/components/openresponsesfunctioncalloutput.py
- src/openrouter/components/openresponsesfunctionshelltool.py
- src/openrouter/components/openresponsesfunctiontoolcall.py - src/openrouter/components/openresponsesfunctiontoolcall.py
- src/openrouter/components/openresponsesimagegencallcompleted.py - src/openrouter/components/openresponsesimagegencallcompleted.py
- src/openrouter/components/openresponsesimagegencallgenerating.py - src/openrouter/components/openresponsesimagegencallgenerating.py
- src/openrouter/components/openresponsesimagegencallinprogress.py - src/openrouter/components/openresponsesimagegencallinprogress.py
- src/openrouter/components/openresponsesimagegencallpartialimage.py - src/openrouter/components/openresponsesimagegencallpartialimage.py
- src/openrouter/components/openresponsesimagegenerationtool.py - src/openrouter/components/openresponsesinput.py
- src/openrouter/components/openresponsesinput_union.py
- src/openrouter/components/openresponsesinputmessageitem.py - src/openrouter/components/openresponsesinputmessageitem.py
- src/openrouter/components/openresponseslocalshelltool.py - src/openrouter/components/openresponseslogprobs.py
- src/openrouter/components/openresponsesmcptool.py
- src/openrouter/components/openresponsesnonstreamingresponse.py - src/openrouter/components/openresponsesnonstreamingresponse.py
- src/openrouter/components/openresponsesreasoning.py - src/openrouter/components/openresponsesreasoning.py
- src/openrouter/components/openresponsesreasoningconfig.py - src/openrouter/components/openresponsesreasoningconfig.py
@@ -927,6 +727,7 @@ generatedFiles:
- src/openrouter/components/openresponsesrequest.py - src/openrouter/components/openresponsesrequest.py
- src/openrouter/components/openresponsesresponsetext.py - src/openrouter/components/openresponsesresponsetext.py
- src/openrouter/components/openresponsesstreamevent.py - src/openrouter/components/openresponsesstreamevent.py
- src/openrouter/components/openresponsestoplogprobs.py
- src/openrouter/components/openresponsesusage.py - src/openrouter/components/openresponsesusage.py
- src/openrouter/components/openresponseswebsearch20250826tool.py - src/openrouter/components/openresponseswebsearch20250826tool.py
- src/openrouter/components/openresponseswebsearchpreview20250311tool.py - src/openrouter/components/openresponseswebsearchpreview20250311tool.py
@@ -951,23 +752,17 @@ generatedFiles:
- src/openrouter/components/providerpreferences.py - src/openrouter/components/providerpreferences.py
- src/openrouter/components/providersort.py - src/openrouter/components/providersort.py
- src/openrouter/components/providersortconfig.py - src/openrouter/components/providersortconfig.py
- src/openrouter/components/providersortunion.py
- src/openrouter/components/publicendpoint.py - src/openrouter/components/publicendpoint.py
- src/openrouter/components/publicpricing.py - src/openrouter/components/publicpricing.py
- src/openrouter/components/quantization.py - src/openrouter/components/quantization.py
- src/openrouter/components/reasoningdetailencrypted.py
- src/openrouter/components/reasoningdetailsummary.py
- src/openrouter/components/reasoningdetailtext.py
- src/openrouter/components/reasoningdetailunion.py
- src/openrouter/components/reasoningsummarytext.py - src/openrouter/components/reasoningsummarytext.py
- src/openrouter/components/reasoningsummaryverbosity.py - src/openrouter/components/reasoningsummaryverbosity.py
- src/openrouter/components/reasoningtextcontent.py - src/openrouter/components/reasoningtextcontent.py
- src/openrouter/components/requesttimeoutresponseerrordata.py - src/openrouter/components/requesttimeoutresponseerrordata.py
- src/openrouter/components/responseformatjsonobject.py
- src/openrouter/components/responseformatjsonschema.py - src/openrouter/components/responseformatjsonschema.py
- src/openrouter/components/responseformattext.py
- src/openrouter/components/responseformattextconfig.py - src/openrouter/components/responseformattextconfig.py
- src/openrouter/components/responseformattextgrammar.py - src/openrouter/components/responseformattextgrammar.py
- src/openrouter/components/responseformattextpython.py
- src/openrouter/components/responseinputaudio.py - src/openrouter/components/responseinputaudio.py
- src/openrouter/components/responseinputfile.py - src/openrouter/components/responseinputfile.py
- src/openrouter/components/responseinputimage.py - src/openrouter/components/responseinputimage.py
@@ -975,6 +770,7 @@ generatedFiles:
- src/openrouter/components/responseinputvideo.py - src/openrouter/components/responseinputvideo.py
- src/openrouter/components/responseoutputtext.py - src/openrouter/components/responseoutputtext.py
- src/openrouter/components/responseserrorfield.py - src/openrouter/components/responseserrorfield.py
- src/openrouter/components/responsesformatjsonobject.py
- src/openrouter/components/responsesformattext.py - src/openrouter/components/responsesformattext.py
- src/openrouter/components/responsesformattextjsonschemaconfig.py - src/openrouter/components/responsesformattextjsonschemaconfig.py
- src/openrouter/components/responsesimagegenerationcall.py - src/openrouter/components/responsesimagegenerationcall.py
@@ -992,7 +788,6 @@ generatedFiles:
- src/openrouter/components/serviceunavailableresponseerrordata.py - src/openrouter/components/serviceunavailableresponseerrordata.py
- src/openrouter/components/systemmessage.py - src/openrouter/components/systemmessage.py
- src/openrouter/components/toolcallstatus.py - src/openrouter/components/toolcallstatus.py
- src/openrouter/components/toolchoiceoption.py
- src/openrouter/components/tooldefinitionjson.py - src/openrouter/components/tooldefinitionjson.py
- src/openrouter/components/toolresponsemessage.py - src/openrouter/components/toolresponsemessage.py
- src/openrouter/components/toomanyrequestsresponseerrordata.py - src/openrouter/components/toomanyrequestsresponseerrordata.py
@@ -1001,7 +796,6 @@ generatedFiles:
- src/openrouter/components/unprocessableentityresponseerrordata.py - src/openrouter/components/unprocessableentityresponseerrordata.py
- src/openrouter/components/urlcitation.py - src/openrouter/components/urlcitation.py
- src/openrouter/components/usermessage.py - src/openrouter/components/usermessage.py
- src/openrouter/components/videoinput.py
- src/openrouter/components/websearchengine.py - src/openrouter/components/websearchengine.py
- src/openrouter/components/websearchpreviewtooluserlocation.py - src/openrouter/components/websearchpreviewtooluserlocation.py
- src/openrouter/components/websearchstatus.py - src/openrouter/components/websearchstatus.py
@@ -1011,6 +805,7 @@ generatedFiles:
- src/openrouter/errors/__init__.py - src/openrouter/errors/__init__.py
- src/openrouter/errors/badgatewayresponse_error.py - src/openrouter/errors/badgatewayresponse_error.py
- src/openrouter/errors/badrequestresponse_error.py - src/openrouter/errors/badrequestresponse_error.py
- src/openrouter/errors/chaterror.py
- src/openrouter/errors/edgenetworktimeoutresponse_error.py - src/openrouter/errors/edgenetworktimeoutresponse_error.py
- src/openrouter/errors/forbiddenresponse_error.py - src/openrouter/errors/forbiddenresponse_error.py
- src/openrouter/errors/internalserverresponse_error.py - src/openrouter/errors/internalserverresponse_error.py
@@ -1057,7 +852,6 @@ generatedFiles:
- src/openrouter/operations/getmodels.py - src/openrouter/operations/getmodels.py
- src/openrouter/operations/getuseractivity.py - src/openrouter/operations/getuseractivity.py
- src/openrouter/operations/list.py - src/openrouter/operations/list.py
- src/openrouter/operations/listembeddingsmodels.py
- src/openrouter/operations/listendpoints.py - src/openrouter/operations/listendpoints.py
- src/openrouter/operations/listendpointszdr.py - src/openrouter/operations/listendpointszdr.py
- src/openrouter/operations/listguardrailkeyassignments.py - src/openrouter/operations/listguardrailkeyassignments.py
@@ -1065,7 +859,6 @@ generatedFiles:
- src/openrouter/operations/listguardrails.py - src/openrouter/operations/listguardrails.py
- src/openrouter/operations/listkeyassignments.py - src/openrouter/operations/listkeyassignments.py
- src/openrouter/operations/listmemberassignments.py - src/openrouter/operations/listmemberassignments.py
- src/openrouter/operations/listmodelscount.py
- src/openrouter/operations/listmodelsuser.py - src/openrouter/operations/listmodelsuser.py
- src/openrouter/operations/listproviders.py - src/openrouter/operations/listproviders.py
- src/openrouter/operations/sendchatcompletionrequest.py - src/openrouter/operations/sendchatcompletionrequest.py
@@ -1142,7 +935,7 @@ examples:
"401": "401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"403": "403":
application/json: {"error": {"code": 403, "message": "Only management keys can perform this operation"}} application/json: {"error": {"code": 403, "message": "Only provisioning keys can perform this operation"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
getCredits: getCredits:
@@ -1153,7 +946,7 @@ examples:
"401": "401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"403": "403":
application/json: {"error": {"code": 403, "message": "Only management keys can perform this operation"}} application/json: {"error": {"code": 403, "message": "Only provisioning keys can perform this operation"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
createCoinbaseCharge: createCoinbaseCharge:
@@ -1215,7 +1008,7 @@ examples:
id: "<id>" id: "<id>"
responses: responses:
"200": "200":
application/json: {"data": {"id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", "upstream_id": "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", "total_cost": 0.0015, "cache_discount": 0.0002, "upstream_inference_cost": 0.0012, "created_at": "2024-07-15T23:33:19.433273+00:00", "model": "sao10k/l3-stheno-8b", "app_id": 12345, "streamed": true, "cancelled": false, "provider_name": "Infermatic", "latency": 1250, "moderation_latency": 50, "generation_time": 1200, "finish_reason": "stop", "tokens_prompt": 10, "tokens_completion": 25, "native_tokens_prompt": 10, "native_tokens_completion": 25, "native_tokens_completion_images": 0, "native_tokens_reasoning": 5, "native_tokens_cached": 3, "num_media_prompt": 1, "num_input_audio_prompt": 0, "num_media_completion": 0, "num_search_results": 5, "origin": "https://openrouter.ai/", "usage": 0.0015, "is_byok": false, "native_finish_reason": "stop", "external_user": "user-123", "api_type": "completions", "router": "openrouter/auto", "provider_responses": [], "user_agent": "<value>", "http_referer": null}} application/json: {"data": {"id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", "upstream_id": "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", "total_cost": 0.0015, "cache_discount": 0.0002, "upstream_inference_cost": 0.0012, "created_at": "2024-07-15T23:33:19.433273+00:00", "model": "sao10k/l3-stheno-8b", "app_id": 12345, "streamed": true, "cancelled": false, "provider_name": "Infermatic", "latency": 1250, "moderation_latency": 50, "generation_time": 1200, "finish_reason": "stop", "tokens_prompt": 10, "tokens_completion": 25, "native_tokens_prompt": 10, "native_tokens_completion": 25, "native_tokens_completion_images": 0, "native_tokens_reasoning": 5, "native_tokens_cached": 3, "num_media_prompt": 1, "num_input_audio_prompt": 0, "num_media_completion": 0, "num_search_results": 5, "origin": "https://openrouter.ai/", "usage": 0.0015, "is_byok": false, "native_finish_reason": "stop", "external_user": "user-123", "api_type": "completions", "router": "openrouter/auto", "provider_responses": []}}
"401": "401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"402": "402":
@@ -1239,8 +1032,6 @@ examples:
application/json: {"data": {"count": 150}} application/json: {"data": {"count": 150}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
"400":
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
getModels: getModels:
speakeasy-default-get-models: speakeasy-default-get-models:
responses: responses:
@@ -1389,7 +1180,7 @@ examples:
speakeasy-default-get-current-key: speakeasy-default-get-current-key:
responses: responses:
"200": "200":
application/json: {"data": {"label": "sk-or-v1-au7...890", "limit": 100, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "is_free_tier": false, "is_management_key": false, "is_provisioning_key": false, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "rate_limit": {"requests": 1000, "interval": "1h", "note": "This field is deprecated and safe to ignore."}}} application/json: {"data": {"label": "sk-or-v1-au7...890", "limit": 100, "usage": 25.5, "usage_daily": 25.5, "usage_weekly": 25.5, "usage_monthly": 25.5, "byok_usage": 17.38, "byok_usage_daily": 17.38, "byok_usage_weekly": 17.38, "byok_usage_monthly": 17.38, "is_free_tier": false, "is_provisioning_key": false, "limit_remaining": 74.5, "limit_reset": "monthly", "include_byok_in_limit": false, "rate_limit": {"requests": 1000, "interval": "1h", "note": "This field is deprecated and safe to ignore."}}}
"401": "401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}} application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"500": "500":
@@ -1404,7 +1195,7 @@ examples:
"400": "400":
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}} application/json: {"error": {"code": 400, "message": "Invalid request parameters"}}
"403": "403":
application/json: {"error": {"code": 403, "message": "Only management keys can perform this operation"}} application/json: {"error": {"code": 403, "message": "Only provisioning keys can perform this operation"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": 500, "message": "Internal Server Error"}}
createAuthKeysCode: createAuthKeysCode:
@@ -1423,36 +1214,14 @@ examples:
sendChatCompletionRequest: sendChatCompletionRequest:
speakeasy-default-send-chat-completion-request: speakeasy-default-send-chat-completion-request:
requestBody: requestBody:
application/json: {"messages": [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "What is the capital of France?"}], "stream": false, "temperature": 0.7, "top_p": 1} application/json: {"messages": [], "stream": false}
responses: responses:
"200": "200":
application/json: {"id": "chatcmpl-123", "choices": [{"finish_reason": "stop", "index": 0, "message": {"role": "assistant"}}], "created": 1677652288, "model": "openai/gpt-4", "object": "chat.completion", "system_fingerprint": "fp_44709d6fcb"} application/json: {"id": "<id>", "choices": [], "created": 6524.91, "model": "Silverado", "object": "chat.completion"}
"400": "400":
application/json: {"error": {"code": 400, "message": "Invalid request parameters"}} application/json: {"error": {"code": "<value>", "message": "<value>"}}
"500": "500":
application/json: {"error": {"code": 500, "message": "Internal Server Error"}} application/json: {"error": {"code": "<value>", "message": "<value>"}}
"401":
application/json: {"error": {"code": 401, "message": "Missing Authentication header"}}
"402":
application/json: {"error": {"code": 402, "message": "Insufficient credits. Add more using https://openrouter.ai/credits"}}
"404":
application/json: {"error": {"code": 404, "message": "Resource not found"}}
"408":
application/json: {"error": {"code": 408, "message": "Operation timed out. Please try again later."}}
"413":
application/json: {"error": {"code": 413, "message": "Request payload too large"}}
"422":
application/json: {"error": {"code": 422, "message": "Invalid argument"}}
"429":
application/json: {"error": {"code": 429, "message": "Rate limit exceeded"}}
"502":
application/json: {"error": {"code": 502, "message": "Provider returned error"}}
"503":
application/json: {"error": {"code": 503, "message": "Service temporarily unavailable"}}
"524":
application/json: {"error": {"code": 524, "message": "Request timed out. Please try again later."}}
"529":
application/json: {"error": {"code": 529, "message": "Provider returned error"}}
createCompletions: createCompletions:
speakeasy-default-create-completions: speakeasy-default-create-completions:
requestBody: requestBody:
+1 -1
View File
@@ -31,7 +31,7 @@ generation:
skipResponseBodyAssertions: false skipResponseBodyAssertions: false
preApplyUnionDiscriminators: true preApplyUnionDiscriminators: true
python: python:
version: 0.7.12 version: 0.4.1
additionalDependencies: additionalDependencies:
dev: {} dev: {}
main: {} main: {}
+1725 -5784
View File
File diff suppressed because it is too large Load Diff
+1709 -5902
View File
File diff suppressed because it is too large Load Diff
+3 -20
View File
@@ -1,18 +1,17 @@
overlay: 1.0.0 overlay: 1.0.0
x-speakeasy-jsonpath: rfc9535 x-speakeasy-jsonpath: rfc9535
info: info:
title: Add HTTP-Referer and X-OpenRouter-Title as global parameters title: Add HTTP-Referer and X-Title as global parameters
version: 0.0.0 version: 0.0.0
actions: actions:
# Add global parameters for app identification # Add global parameters for app identification
- target: $ - target: $
description: Add x-speakeasy-globals for HTTP-Referer, X-OpenRouter-Title, and X-OpenRouter-Categories headers description: Add x-speakeasy-globals for HTTP-Referer and X-Title headers
update: update:
x-speakeasy-globals: x-speakeasy-globals:
parameters: parameters:
- $ref: "#/components/parameters/AppIdentifier" - $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName" - $ref: "#/components/parameters/AppDisplayName"
- $ref: "#/components/parameters/AppCategories"
# Add component parameters # Add component parameters
- target: $.components - target: $.components
@@ -28,25 +27,9 @@ actions:
The app identifier should be your app's URL and is used as the primary identifier for rankings. The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application. This is used to track API usage per application.
AppDisplayName: AppDisplayName:
name: X-OpenRouter-Title name: X-Title
in: header in: header
schema: schema:
type: string type: string
description: | description: |
The app display name allows you to customize how your app appears in OpenRouter's dashboard. The app display name allows you to customize how your app appears in OpenRouter's dashboard.
AppCategories:
name: X-OpenRouter-Categories
in: header
schema:
type: string
description: |
Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
# Add header parameters to all paths so Speakeasy matches them with globals
- target: $.paths[*]
description: Reference app identification headers on all paths so Speakeasy injects them via globals
update:
parameters:
- $ref: "#/components/parameters/AppIdentifier"
- $ref: "#/components/parameters/AppDisplayName"
- $ref: "#/components/parameters/AppCategories"
+5 -5
View File
@@ -8,8 +8,8 @@ sources:
- latest - latest
OpenRouter API: OpenRouter API:
sourceNamespace: open-router-chat-completions-api sourceNamespace: open-router-chat-completions-api
sourceRevisionDigest: sha256:6b805ea430a51e0e4d11cd3b3165f9ff26b37973a0bba53ecc126f990d5fb707 sourceRevisionDigest: sha256:081a51121f970e44311f1415c10c22b1838d1d1b6057280a3e6cba78acab1dca
sourceBlobDigest: sha256:65e20830b3e0a412d17017ce0c6c15a31e6069a7b273da22ea3880502725930e sourceBlobDigest: sha256:fc6bdfffd4edd78b043363b817794d80faaa927b5b4b7e8f149fda68084dac13
tags: tags:
- latest - latest
- main - main
@@ -18,10 +18,10 @@ targets:
open-router: open-router:
source: OpenRouter API source: OpenRouter API
sourceNamespace: open-router-chat-completions-api sourceNamespace: open-router-chat-completions-api
sourceRevisionDigest: sha256:6b805ea430a51e0e4d11cd3b3165f9ff26b37973a0bba53ecc126f990d5fb707 sourceRevisionDigest: sha256:081a51121f970e44311f1415c10c22b1838d1d1b6057280a3e6cba78acab1dca
sourceBlobDigest: sha256:65e20830b3e0a412d17017ce0c6c15a31e6069a7b273da22ea3880502725930e sourceBlobDigest: sha256:fc6bdfffd4edd78b043363b817794d80faaa927b5b4b7e8f149fda68084dac13
codeSamplesNamespace: open-router-python-code-samples codeSamplesNamespace: open-router-python-code-samples
codeSamplesRevisionDigest: sha256:44bca5099ff33e05a3f4e5acf8f83f48dc1d84efc8758381a528abcc871bc874 codeSamplesRevisionDigest: sha256:c48795939148c825d881d736e1b7a8d884b6b7e3f66114a5e11d4ed532b75baa
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: 1.666.0 speakeasyVersion: 1.666.0
-6
View File
@@ -182,9 +182,6 @@ import os
def main(): def main():
with OpenRouter( with OpenRouter(
http_referer="<value>",
x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
@@ -194,9 +191,6 @@ def main():
async def amain(): async def amain():
async with OpenRouter( async with OpenRouter(
http_referer="<value>",
x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
-6
View File
@@ -182,9 +182,6 @@ import os
def main(): def main():
with OpenRouter( with OpenRouter(
http_referer="<value>",
x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
@@ -194,9 +191,6 @@ def main():
async def amain(): async def amain():
async with OpenRouter( async with OpenRouter(
http_referer="<value>",
x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
# Rest of application here... # Rest of application here...
-6
View File
@@ -6,9 +6,6 @@ import os
with OpenRouter( with OpenRouter(
http_referer="<value>",
x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
@@ -33,9 +30,6 @@ import os
async def main(): async def main():
async with OpenRouter( async with OpenRouter(
http_referer="<value>",
x_open_router_title="<value>",
x_open_router_categories="<value>",
api_key=os.getenv("OPENROUTER_API_KEY", ""), api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router: ) as open_router:
-23
View File
@@ -1,23 +0,0 @@
# Action
## Supported Types
### `components.ActionSearch`
```python
value: components.ActionSearch = /* values here */
```
### `components.ActionOpenPage`
```python
value: components.ActionOpenPage = /* values here */
```
### `components.ActionFindInPage`
```python
value: components.ActionFindInPage = /* values here */
```
-10
View File
@@ -1,10 +0,0 @@
# ActionFindInPage
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `type` | [components.TypeFindInPage](../components/typefindinpage.md) | :heavy_check_mark: | N/A |
| `pattern` | *str* | :heavy_check_mark: | N/A |
| `url` | *str* | :heavy_check_mark: | N/A |
-11
View File
@@ -1,11 +0,0 @@
# ActionSearch
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `type` | [components.TypeSearch](../components/typesearch.md) | :heavy_check_mark: | N/A |
| `query` | *str* | :heavy_check_mark: | N/A |
| `queries` | List[*str*] | :heavy_minus_sign: | N/A |
| `sources` | List[[components.Source](../components/source.md)] | :heavy_minus_sign: | N/A |
+10 -13
View File
@@ -1,18 +1,15 @@
# AssistantMessage # AssistantMessage
Assistant message for requests and responses
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `role` | [components.AssistantMessageRole](../components/assistantmessagerole.md) | :heavy_check_mark: | N/A | | | `role` | *Literal["assistant"]* | :heavy_check_mark: | N/A |
| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | | | `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | N/A |
| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | | | `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls made by the assistant | | | `tool_calls` | List[[components.ChatMessageToolCall](../components/chatmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message if content was refused | | | `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | | | `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | | | `reasoning_details` | List[[components.Schema19](../components/schema19.md)] | :heavy_minus_sign: | N/A |
| `images` | List[[components.AssistantMessageImages](../components/assistantmessageimages.md)] | :heavy_minus_sign: | Generated images from image generation models | [<br/>{<br/>"image_url": {<br/>"url": "data:image/png;base64,iVBORw0KGgo..."<br/>}<br/>}<br/>] | | `images` | List[[components.Image](../components/image.md)] | :heavy_minus_sign: | N/A |
| `audio` | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md) | :heavy_minus_sign: | Audio output data or reference | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |
@@ -1,7 +1,5 @@
# AssistantMessageContent # AssistantMessageContent
Assistant message content
## Supported Types ## Supported Types
@@ -17,9 +15,3 @@ value: str = /* values here */
value: List[components.ChatMessageContentItem] = /* values here */ value: List[components.ChatMessageContentItem] = /* values here */
``` ```
### `Any`
```python
value: Any = /* values here */
```
@@ -1,8 +0,0 @@
# AssistantMessageImages
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `image_url` | [components.AssistantMessageImagesImageURL](../components/assistantmessageimagesimageurl.md) | :heavy_check_mark: | N/A |
@@ -1,8 +0,0 @@
# AssistantMessageImagesImageURL
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| `url` | *str* | :heavy_check_mark: | URL or base64-encoded data of the generated image |
@@ -1,9 +1,8 @@
# AllowedTools # AssistantMessageImageURL
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ | | ------------------ | ------------------ | ------------------ | ------------------ |
| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | | `url` | *str* | :heavy_check_mark: | N/A |
| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A |
-8
View File
@@ -1,8 +0,0 @@
# AssistantMessageRole
## Values
| Name | Value |
| ----------- | ----------- |
| `ASSISTANT` | assistant |
-10
View File
@@ -1,10 +0,0 @@
# Background
## Values
| Name | Value |
| ------------- | ------------- |
| `TRANSPARENT` | transparent |
| `OPAQUE` | opaque |
| `AUTO` | auto |
-13
View File
@@ -1,13 +0,0 @@
# By
The provider sorting strategy (price, throughput, latency)
## Values
| Name | Value |
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `EXACTO` | exacto |
-11
View File
@@ -1,11 +0,0 @@
# CacheControl
Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `type` | [components.ChatGenerationParamsType](../components/chatgenerationparamstype.md) | :heavy_check_mark: | N/A |
| `ttl` | [Optional[components.ChatGenerationParamsTTL]](../components/chatgenerationparamsttl.md) | :heavy_minus_sign: | N/A |
@@ -1,13 +0,0 @@
# ChatCompletionAudioOutput
Audio output data or reference
## Fields
| Field | Type | Required | Description |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `id` | *Optional[str]* | :heavy_minus_sign: | Audio output identifier |
| `expires_at` | *Optional[float]* | :heavy_minus_sign: | Audio expiration timestamp |
| `data` | *Optional[str]* | :heavy_minus_sign: | Base64 encoded audio data |
| `transcript` | *Optional[str]* | :heavy_minus_sign: | Audio transcript |
+11
View File
@@ -0,0 +1,11 @@
# ChatErrorError
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| `code` | [Nullable[components.Code]](../components/code.md) | :heavy_check_mark: | N/A |
| `message` | *str* | :heavy_check_mark: | N/A |
| `param` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `type` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
+31 -35
View File
@@ -1,40 +1,36 @@
# ChatGenerationParams # ChatGenerationParams
Chat completion request parameters
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `provider` | [OptionalNullable[components.ChatGenerationParamsProvider]](../components/chatgenerationparamsprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | | | `provider` | [OptionalNullable[components.Schema0]](../components/schema0.md) | :heavy_minus_sign: | N/A |
| `plugins` | List[[components.ChatGenerationParamsPluginUnion](../components/chatgenerationparamspluginunion.md)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | | `plugins` | List[[components.Schema17](../components/schema17.md)] | :heavy_minus_sign: | N/A |
| `user` | *Optional[str]* | :heavy_minus_sign: | Unique user identifier | user-123 | | `route` | [OptionalNullable[components.Route]](../components/route.md) | :heavy_minus_sign: | N/A |
| `session_id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. | | | `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `trace` | [Optional[components.ChatGenerationParamsTrace]](../components/chatgenerationparamstrace.md) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | | | `session_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `messages` | List[[components.Message](../components/message.md)] | :heavy_check_mark: | List of messages for the conversation | [<br/>{<br/>"role": "user",<br/>"content": "Hello!"<br/>}<br/>] | | `messages` | List[[components.Message](../components/message.md)] | :heavy_check_mark: | N/A |
| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | | `model` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [<br/>"openai/gpt-4",<br/>"openai/gpt-4o"<br/>] | | `models` | List[*str*] | :heavy_minus_sign: | N/A |
| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | | `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | {<br/>"50256": -100<br/>} | | `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A |
| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | | `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | | `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | | `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | | `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | {<br/>"user_id": "user-123",<br/>"session_id": "session-456"<br/>} | | `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A |
| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | | `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | Configuration options for reasoning models | {<br/>"effort": "medium",<br/>"summary": "concise"<br/>} | | `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | N/A |
| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.md) | :heavy_minus_sign: | Response format configuration | {<br/>"type": "json_object"<br/>} | | `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.md) | :heavy_minus_sign: | N/A |
| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | | `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
| `stop` | [OptionalNullable[components.Stop]](../components/stop.md) | :heavy_minus_sign: | Stop sequences (up to 4) | [<br/>""<br/>] | | `stop` | [OptionalNullable[components.Stop]](../components/stop.md) | :heavy_minus_sign: | N/A |
| `stream` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | | `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A |
| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md) | :heavy_minus_sign: | Streaming configuration options | {<br/>"include_usage": true<br/>} | | `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md) | :heavy_minus_sign: | N/A |
| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | | `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | | `tool_choice` | *Optional[Any]* | :heavy_minus_sign: | N/A |
| `tool_choice` | [Optional[components.ToolChoiceOption]](../components/toolchoiceoption.md) | :heavy_minus_sign: | Tool choice configuration | auto | | `tools` | List[[components.ToolDefinitionJSON](../components/tooldefinitionjson.md)] | :heavy_minus_sign: | N/A |
| `tools` | List[[components.ToolDefinitionJSON](../components/tooldefinitionjson.md)] | :heavy_minus_sign: | Available tools for function calling | [<br/>{<br/>"type": "function",<br/>"function": {<br/>"name": "get_weather",<br/>"description": "Get weather"<br/>}<br/>}<br/>] | | `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | | `debug` | [Optional[components.Debug]](../components/debug.md) | :heavy_minus_sign: | N/A |
| `debug` | [Optional[components.DebugOptions]](../components/debugoptions.md) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | {<br/>"echo_upstream_body": true<br/>} | | `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | N/A |
| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](../components/chatgenerationparamsimageconfig.md)] | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | {<br/>"aspect_ratio": "16:9"<br/>} | | `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | N/A |
| `modalities` | List[[components.Modality](../components/modality.md)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [<br/>"text",<br/>"image"<br/>] |
| `cache_control` | [Optional[components.CacheControl]](../components/cachecontrol.md) | :heavy_minus_sign: | Enable automatic prompt caching. When set, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. | |
-13
View File
@@ -1,13 +0,0 @@
# ChatGenerationParamsBy
The provider sorting strategy (price, throughput, latency)
## Values
| Name | Value |
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `EXACTO` | exacto |
@@ -1,8 +0,0 @@
# ChatGenerationParamsIDAutoRouter
## Values
| Name | Value |
| ------------- | ------------- |
| `AUTO_ROUTER` | auto-router |
@@ -1,8 +0,0 @@
# ChatGenerationParamsIDFileParser
## Values
| Name | Value |
| ------------- | ------------- |
| `FILE_PARSER` | file-parser |
@@ -1,8 +0,0 @@
# ChatGenerationParamsIDModeration
## Values
| Name | Value |
| ------------ | ------------ |
| `MODERATION` | moderation |
@@ -1,8 +0,0 @@
# ChatGenerationParamsIDWeb
## Values
| Name | Value |
| ----- | ----- |
| `WEB` | web |
@@ -1,17 +0,0 @@
# ChatGenerationParamsIgnore
## Supported Types
### `components.ProviderName`
```python
value: components.ProviderName = /* values here */
```
### `str`
```python
value: str = /* values here */
```
@@ -15,9 +15,9 @@ value: str = /* values here */
value: float = /* values here */ value: float = /* values here */
``` ```
### `List[Nullable[Any]]` ### `List[Any]`
```python ```python
value: List[Nullable[Any]] = /* values here */ value: List[Any] = /* values here */
``` ```
@@ -1,14 +0,0 @@
# ChatGenerationParamsMaxPrice
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 | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `prompt` | *Optional[str]* | :heavy_minus_sign: | Price per million prompt tokens | 1000 |
| `completion` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 |
@@ -1,17 +0,0 @@
# ChatGenerationParamsOnly
## Supported Types
### `components.ProviderName`
```python
value: components.ProviderName = /* values here */
```
### `str`
```python
value: str = /* values here */
```
@@ -1,17 +0,0 @@
# ChatGenerationParamsOrder
## Supported Types
### `components.ProviderName`
```python
value: components.ProviderName = /* values here */
```
### `str`
```python
value: str = /* values here */
```
@@ -1,11 +0,0 @@
# ChatGenerationParamsPartition
Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model.
## Values
| Name | Value |
| ------- | ------- |
| `MODEL` | model |
| `NONE` | none |
@@ -1,10 +0,0 @@
# ChatGenerationParamsPluginFileParser
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `id` | [components.ChatGenerationParamsIDFileParser](../components/chatgenerationparamsidfileparser.md) | :heavy_check_mark: | N/A |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. |
| `pdf` | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.md) | :heavy_minus_sign: | Options for PDF parsing. |
@@ -1,8 +0,0 @@
# ChatGenerationParamsPluginModeration
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `id` | [components.ChatGenerationParamsIDModeration](../components/chatgenerationparamsidmoderation.md) | :heavy_check_mark: | N/A |
@@ -1,9 +0,0 @@
# ChatGenerationParamsPluginResponseHealing
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `id` | [components.ChatGenerationParamsIDResponseHealing](../components/chatgenerationparamsidresponsehealing.md) | :heavy_check_mark: | N/A |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. |
@@ -1,35 +0,0 @@
# ChatGenerationParamsPluginUnion
## Supported Types
### `components.ChatGenerationParamsPluginAutoRouter`
```python
value: components.ChatGenerationParamsPluginAutoRouter = /* values here */
```
### `components.ChatGenerationParamsPluginModeration`
```python
value: components.ChatGenerationParamsPluginModeration = /* values here */
```
### `components.ChatGenerationParamsPluginWeb`
```python
value: components.ChatGenerationParamsPluginWeb = /* values here */
```
### `components.ChatGenerationParamsPluginFileParser`
```python
value: components.ChatGenerationParamsPluginFileParser = /* values here */
```
### `components.ChatGenerationParamsPluginResponseHealing`
```python
value: components.ChatGenerationParamsPluginResponseHealing = /* values here */
```
@@ -1,14 +0,0 @@
# ChatGenerationParamsPluginWeb
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md) | :heavy_check_mark: | N/A | |
| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | |
| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A | |
| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | |
| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.md) | :heavy_minus_sign: | The search engine to use for web search. | |
| `include_domains` | List[*str*] | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>] |
| `exclude_domains` | List[*str*] | :heavy_minus_sign: | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>] |
@@ -1,22 +0,0 @@
# ChatGenerationParamsProvider
When multiple model providers are available, optionally indicate your routing preference.
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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[components.DataCollection]](../components/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/><br/>- deny: use only providers which do not collect user data. | allow |
| `zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true |
| `enforce_distillable_text` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true |
| `order` | List[[components.ChatGenerationParamsOrder](../components/chatgenerationparamsorder.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[[components.ChatGenerationParamsOnly](../components/chatgenerationparamsonly.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[[components.ChatGenerationParamsIgnore](../components/chatgenerationparamsignore.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[[components.Quantization](../components/quantization.md)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | |
| `sort` | [OptionalNullable[components.ChatGenerationParamsSortUnion]](../components/chatgenerationparamssortunion.md) | :heavy_minus_sign: | N/A | price |
| `max_price` | [Optional[components.ChatGenerationParamsMaxPrice]](../components/chatgenerationparamsmaxprice.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. | |
| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../components/preferredminthroughput.md) | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 |
| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../components/preferredmaxlatency.md) | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 |
@@ -1,13 +0,0 @@
# ChatGenerationParamsProviderSort
The provider sorting strategy (price, throughput, latency)
## Values
| Name | Value |
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `EXACTO` | exacto |
@@ -1,9 +0,0 @@
# ChatGenerationParamsProviderSortConfig
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `by` | [OptionalNullable[components.ChatGenerationParamsBy]](../components/chatgenerationparamsby.md) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price |
| `partition` | [OptionalNullable[components.ChatGenerationParamsPartition]](../components/chatgenerationparamspartition.md) | :heavy_minus_sign: | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model |
@@ -1,11 +0,0 @@
# ChatGenerationParamsProviderSortConfigEnum
## Values
| Name | Value |
| ------------ | ------------ |
| `PRICE` | price |
| `THROUGHPUT` | throughput |
| `LATENCY` | latency |
| `EXACTO` | exacto |
@@ -1,17 +0,0 @@
# ChatGenerationParamsProviderSortConfigUnion
## Supported Types
### `components.ChatGenerationParamsProviderSortConfig`
```python
value: components.ChatGenerationParamsProviderSortConfig = /* values here */
```
### `components.ChatGenerationParamsProviderSortConfigEnum`
```python
value: components.ChatGenerationParamsProviderSortConfigEnum = /* values here */
```
@@ -1,25 +0,0 @@
# ChatGenerationParamsSortUnion
The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
## Supported Types
### `components.ChatGenerationParamsProviderSort`
```python
value: components.ChatGenerationParamsProviderSort = /* values here */
```
### `components.ChatGenerationParamsProviderSortConfigUnion`
```python
value: components.ChatGenerationParamsProviderSortConfigUnion = /* values here */
```
### `components.ChatGenerationParamsSortEnum`
```python
value: components.ChatGenerationParamsSortEnum = /* values here */
```
@@ -1,15 +0,0 @@
# ChatGenerationParamsTrace
Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations.
## Fields
| Field | Type | Required | Description |
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
| `trace_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `trace_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `span_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `generation_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `parent_span_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A |
@@ -1,8 +0,0 @@
# ChatGenerationParamsType
## Values
| Name | Value |
| ----------- | ----------- |
| `EPHEMERAL` | ephemeral |
+5 -7
View File
@@ -1,14 +1,12 @@
# ChatGenerationTokenUsage # ChatGenerationTokenUsage
Token usage statistics
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `completion_tokens` | *float* | :heavy_check_mark: | Number of tokens in the completion | | `completion_tokens` | *float* | :heavy_check_mark: | N/A |
| `prompt_tokens` | *float* | :heavy_check_mark: | Number of tokens in the prompt | | `prompt_tokens` | *float* | :heavy_check_mark: | N/A |
| `total_tokens` | *float* | :heavy_check_mark: | Total number of tokens | | `total_tokens` | *float* | :heavy_check_mark: | N/A |
| `completion_tokens_details` | [OptionalNullable[components.CompletionTokensDetails]](../components/completiontokensdetails.md) | :heavy_minus_sign: | Detailed completion token usage | | `completion_tokens_details` | [OptionalNullable[components.CompletionTokensDetails]](../components/completiontokensdetails.md) | :heavy_minus_sign: | N/A |
| `prompt_tokens_details` | [OptionalNullable[components.PromptTokensDetails]](../components/prompttokensdetails.md) | :heavy_minus_sign: | Detailed prompt token usage | | `prompt_tokens_details` | [OptionalNullable[components.PromptTokensDetails]](../components/prompttokensdetails.md) | :heavy_minus_sign: | N/A |
+4 -6
View File
@@ -1,7 +1,5 @@
# ChatMessageContentItem # ChatMessageContentItem
Content part for chat completion messages
## Supported Types ## Supported Types
@@ -23,15 +21,15 @@ value: components.ChatMessageContentItemImage = /* values here */
value: components.ChatMessageContentItemAudio = /* values here */ value: components.ChatMessageContentItemAudio = /* values here */
``` ```
### `components.ChatMessageContentItem1` ### `components.ChatMessageContentItemVideo`
```python ```python
value: components.ChatMessageContentItem1 = /* values here */ value: components.ChatMessageContentItemVideo = /* values here */
``` ```
### `components.ChatMessageContentItemFile` ### `components.ChatMessageContentItemVideo`
```python ```python
value: components.ChatMessageContentItemFile = /* values here */ value: components.ChatMessageContentItemVideo = /* values here */
``` ```
@@ -1,17 +0,0 @@
# ChatMessageContentItem1
## Supported Types
### `components.ChatMessageContentItemVideoLegacy`
```python
value: components.ChatMessageContentItemVideoLegacy = /* values here */
```
### `components.ChatMessageContentItemVideo`
```python
value: components.ChatMessageContentItemVideo = /* values here */
```
@@ -1,11 +1,9 @@
# ChatMessageContentItemAudio # ChatMessageContentItemAudio
Audio input content part. Supported audio formats vary by provider.
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemAudioType](../components/chatmessagecontentitemaudiotype.md) | :heavy_check_mark: | N/A | | `type` | *Literal["input_audio"]* | :heavy_check_mark: | N/A |
| `input_audio` | [components.ChatMessageContentItemAudioInputAudio](../components/chatmessagecontentitemaudioinputaudio.md) | :heavy_check_mark: | N/A | | `input_audio` | [components.ChatMessageContentItemAudioInputAudio](../components/chatmessagecontentitemaudioinputaudio.md) | :heavy_check_mark: | N/A |
@@ -3,7 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------ | ------------------ | ------------------ | ------------------ |
| `data` | *str* | :heavy_check_mark: | Base64 encoded audio data | | `data` | *str* | :heavy_check_mark: | N/A |
| `format_` | *str* | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | | `format_` | *str* | :heavy_check_mark: | N/A |
@@ -1,8 +0,0 @@
# ChatMessageContentItemAudioType
## Values
| Name | Value |
| ------------- | ------------- |
| `INPUT_AUDIO` | input_audio |
@@ -1,11 +1,9 @@
# ChatMessageContentItemCacheControl # ChatMessageContentItemCacheControl
Cache control for the content part
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `type` | [components.ChatMessageContentItemCacheControlType](../components/chatmessagecontentitemcachecontroltype.md) | :heavy_check_mark: | N/A | | `type` | *Literal["ephemeral"]* | :heavy_check_mark: | N/A |
| `ttl` | [Optional[components.ChatMessageContentItemCacheControlTTL]](../components/chatmessagecontentitemcachecontrolttl.md) | :heavy_minus_sign: | N/A | | `ttl` | [Optional[components.TTL]](../components/ttl.md) | :heavy_minus_sign: | N/A |
@@ -1,9 +0,0 @@
# ChatMessageContentItemCacheControlTTL
## Values
| Name | Value |
| ------- | ------- |
| `FIVEM` | 5m |
| `ONEH` | 1h |
@@ -1,8 +0,0 @@
# ChatMessageContentItemCacheControlType
## Values
| Name | Value |
| ----------- | ----------- |
| `EPHEMERAL` | ephemeral |
@@ -1,11 +0,0 @@
# ChatMessageContentItemFile
File content part for document processing
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemFileType](../components/chatmessagecontentitemfiletype.md) | :heavy_check_mark: | N/A |
| `file` | [components.File](../components/file.md) | :heavy_check_mark: | N/A |
@@ -1,8 +0,0 @@
# ChatMessageContentItemFileType
## Values
| Name | Value |
| ------ | ------ |
| `FILE` | file |
@@ -1,11 +1,9 @@
# ChatMessageContentItemImage # ChatMessageContentItemImage
Image content part for vision models
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `type` | [components.ChatMessageContentItemImageType](../components/chatmessagecontentitemimagetype.md) | :heavy_check_mark: | N/A | | `type` | *Literal["image_url"]* | :heavy_check_mark: | N/A |
| `image_url` | [components.ChatMessageContentItemImageImageURL](../components/chatmessagecontentitemimageimageurl.md) | :heavy_check_mark: | N/A | | `image_url` | [components.ChatMessageContentItemImageImageURL](../components/chatmessagecontentitemimageimageurl.md) | :heavy_check_mark: | N/A |
@@ -1,7 +1,5 @@
# ChatMessageContentItemImageDetail # ChatMessageContentItemImageDetail
Image detail level for vision models
## Values ## Values
@@ -5,5 +5,5 @@
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `url` | *str* | :heavy_check_mark: | URL of the image (data: URLs supported) | | `url` | *str* | :heavy_check_mark: | N/A |
| `detail` | [Optional[components.ChatMessageContentItemImageDetail]](../components/chatmessagecontentitemimagedetail.md) | :heavy_minus_sign: | Image detail level for vision models | | `detail` | [Optional[components.ChatMessageContentItemImageDetail]](../components/chatmessagecontentitemimagedetail.md) | :heavy_minus_sign: | N/A |
@@ -1,8 +0,0 @@
# ChatMessageContentItemImageType
## Values
| Name | Value |
| ----------- | ----------- |
| `IMAGE_URL` | image_url |
@@ -1,12 +1,10 @@
# ChatMessageContentItemText # ChatMessageContentItemText
Text content part
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemTextType](../components/chatmessagecontentitemtexttype.md) | :heavy_check_mark: | N/A | | | `type` | *Literal["text"]* | :heavy_check_mark: | N/A |
| `text` | *str* | :heavy_check_mark: | N/A | | | `text` | *str* | :heavy_check_mark: | N/A |
| `cache_control` | [Optional[components.ChatMessageContentItemCacheControl]](../components/chatmessagecontentitemcachecontrol.md) | :heavy_minus_sign: | Cache control for the content part | {<br/>"type": "ephemeral",<br/>"ttl": "5m"<br/>} | | `cache_control` | [Optional[components.ChatMessageContentItemCacheControl]](../components/chatmessagecontentitemcachecontrol.md) | :heavy_minus_sign: | N/A |
@@ -1,8 +0,0 @@
# ChatMessageContentItemTextType
## Values
| Name | Value |
| ------ | ------ |
| `TEXT` | text |
+12 -6
View File
@@ -1,11 +1,17 @@
# ChatMessageContentItemVideo # ChatMessageContentItemVideo
Video input content part
## Supported Types
## Fields ### `components.ChatMessageContentItemVideoInputVideo`
```python
value: components.ChatMessageContentItemVideoInputVideo = /* values here */
```
### `components.ChatMessageContentItemVideoVideoURL`
```python
value: components.ChatMessageContentItemVideoVideoURL = /* values here */
```
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemVideoType](../components/chatmessagecontentitemvideotype.md) | :heavy_check_mark: | N/A |
| `video_url` | [components.VideoInput](../components/videoinput.md) | :heavy_check_mark: | Video input object |
@@ -0,0 +1,9 @@
# ChatMessageContentItemVideoInputVideo
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| `type` | *Literal["input_video"]* | :heavy_check_mark: | N/A |
| `video_url` | [components.VideoURL1](../components/videourl1.md) | :heavy_check_mark: | N/A |
@@ -1,13 +0,0 @@
# ~~ChatMessageContentItemVideoLegacy~~
Video input content part (legacy format - deprecated)
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `type` | [components.ChatMessageContentItemVideoLegacyType](../components/chatmessagecontentitemvideolegacytype.md) | :heavy_check_mark: | N/A |
| `video_url` | [components.VideoInput](../components/videoinput.md) | :heavy_check_mark: | Video input object |
@@ -1,8 +0,0 @@
# ChatMessageContentItemVideoLegacyType
## Values
| Name | Value |
| ------------- | ------------- |
| `INPUT_VIDEO` | input_video |
@@ -1,8 +0,0 @@
# ChatMessageContentItemVideoType
## Values
| Name | Value |
| ----------- | ----------- |
| `VIDEO_URL` | video_url |
@@ -0,0 +1,9 @@
# ChatMessageContentItemVideoVideoURL
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| `type` | *Literal["video_url"]* | :heavy_check_mark: | N/A |
| `video_url` | [components.VideoURL2](../components/videourl2.md) | :heavy_check_mark: | N/A |
+4 -6
View File
@@ -1,13 +1,11 @@
# ChatMessageTokenLogprob # ChatMessageTokenLogprob
Token log probability information
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `token` | *str* | :heavy_check_mark: | The token | | `token` | *str* | :heavy_check_mark: | N/A |
| `logprob` | *float* | :heavy_check_mark: | Log probability of the token | | `logprob` | *float* | :heavy_check_mark: | N/A |
| `bytes_` | List[*float*] | :heavy_check_mark: | UTF-8 bytes of the token | | `bytes_` | List[*float*] | :heavy_check_mark: | N/A |
| `top_logprobs` | List[[components.ChatMessageTokenLogprobTopLogprob](../components/chatmessagetokenlogprobtoplogprob.md)] | :heavy_check_mark: | Top alternative tokens with probabilities | | `top_logprobs` | List[[components.ChatMessageTokenLogprobTopLogprob](../components/chatmessagetokenlogprobtoplogprob.md)] | :heavy_check_mark: | N/A |
+2 -4
View File
@@ -1,11 +1,9 @@
# ChatMessageTokenLogprobs # ChatMessageTokenLogprobs
Log probabilities for the completion
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | Log probabilities for content tokens | | `content` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | N/A |
| `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_minus_sign: | Log probabilities for refusal tokens | | `refusal` | List[[components.ChatMessageTokenLogprob](../components/chatmessagetokenlogprob.md)] | :heavy_check_mark: | N/A |
+2 -4
View File
@@ -1,12 +1,10 @@
# ChatMessageToolCall # ChatMessageToolCall
Tool call made by the assistant
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | Tool call identifier | | `id` | *str* | :heavy_check_mark: | N/A |
| `type` | [components.ChatMessageToolCallType](../components/chatmessagetoolcalltype.md) | :heavy_check_mark: | N/A | | `type` | *Literal["function"]* | :heavy_check_mark: | N/A |
| `function` | [components.ChatMessageToolCallFunction](../components/chatmessagetoolcallfunction.md) | :heavy_check_mark: | N/A | | `function` | [components.ChatMessageToolCallFunction](../components/chatmessagetoolcallfunction.md) | :heavy_check_mark: | N/A |
@@ -3,7 +3,7 @@
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | | ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *str* | :heavy_check_mark: | Function name to call | | `name` | *str* | :heavy_check_mark: | N/A |
| `arguments` | *str* | :heavy_check_mark: | Function arguments as JSON string | | `arguments` | *str* | :heavy_check_mark: | N/A |
+9 -11
View File
@@ -1,16 +1,14 @@
# ChatResponse # ChatResponse
Chat completion response
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `id` | *str* | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | | `id` | *str* | :heavy_check_mark: | N/A |
| `choices` | List[[components.ChatResponseChoice](../components/chatresponsechoice.md)] | :heavy_check_mark: | List of completion choices | | | `choices` | List[[components.ChatResponseChoice](../components/chatresponsechoice.md)] | :heavy_check_mark: | N/A |
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | | `created` | *float* | :heavy_check_mark: | N/A |
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | | `model` | *str* | :heavy_check_mark: | N/A |
| `object` | [components.ChatResponseObject](../components/chatresponseobject.md) | :heavy_check_mark: | N/A | | | `object` | *Literal["chat.completion"]* | :heavy_check_mark: | N/A |
| `system_fingerprint` | *Nullable[str]* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | | `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} | | `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | N/A |
+6 -8
View File
@@ -1,13 +1,11 @@
# ChatResponseChoice # ChatResponseChoice
Chat completion choice
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `finish_reason` | *Nullable[Any]* | :heavy_check_mark: | N/A | | | `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A |
| `index` | *float* | :heavy_check_mark: | Choice index | 0 | | `index` | *float* | :heavy_check_mark: | N/A |
| `message` | [components.AssistantMessage](../components/assistantmessage.md) | :heavy_check_mark: | Assistant message for requests and responses | {<br/>"role": "user",<br/>"content": "What is the capital of France?"<br/>} | | `message` | [components.AssistantMessage](../components/assistantmessage.md) | :heavy_check_mark: | N/A |
| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | Log probabilities for the completion | {<br/>"content": [<br/>{<br/>"token": " Hello",<br/>"logprob": -0.612345,<br/>"bytes": null,<br/>"top_logprobs": []<br/>}<br/>],<br/>"refusal": null<br/>} | | `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A |
-8
View File
@@ -1,8 +0,0 @@
# ChatResponseObject
## Values
| Name | Value |
| ----------------- | ----------------- |
| `CHAT_COMPLETION` | chat.completion |
+6 -8
View File
@@ -1,13 +1,11 @@
# ChatStreamingChoice # ChatStreamingChoice
Streaming completion choice chunk
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `delta` | [components.ChatStreamingMessageChunk](../components/chatstreamingmessagechunk.md) | :heavy_check_mark: | Delta changes in streaming response | {<br/>"role": "assistant",<br/>"content": "Hello"<br/>} | | `delta` | [components.ChatStreamingMessageChunk](../components/chatstreamingmessagechunk.md) | :heavy_check_mark: | N/A |
| `finish_reason` | *Nullable[Any]* | :heavy_check_mark: | N/A | | | `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A |
| `index` | *float* | :heavy_check_mark: | Choice index | 0 | | `index` | *float* | :heavy_check_mark: | N/A |
| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | Log probabilities for the completion | {<br/>"content": [<br/>{<br/>"token": " Hello",<br/>"logprob": -0.612345,<br/>"bytes": null,<br/>"top_logprobs": []<br/>}<br/>],<br/>"refusal": null<br/>} | | `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A |
+8 -11
View File
@@ -1,16 +1,13 @@
# ChatStreamingMessageChunk # ChatStreamingMessageChunk
Delta changes in streaming response
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | The role of the message author | assistant | | `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | N/A |
| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | Message content delta | Hello | | `content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to | | `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | <nil> | | `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | Tool calls delta | | | `tool_calls` | List[[components.ChatStreamingMessageToolCall](../components/chatstreamingmessagetoolcall.md)] | :heavy_minus_sign: | N/A |
| `reasoning_details` | List[[components.ReasoningDetailUnion](../components/reasoningdetailunion.md)] | :heavy_minus_sign: | Reasoning details for extended thinking models | | | `reasoning_details` | List[[components.Schema19](../components/schema19.md)] | :heavy_minus_sign: | N/A |
| `audio` | [Optional[components.ChatCompletionAudioOutput]](../components/chatcompletionaudiooutput.md) | :heavy_minus_sign: | N/A | {<br/>"id": "audio_abc123",<br/>"expires_at": 1677652400,<br/>"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",<br/>"transcript": "Hello! How can I help you today?"<br/>} |
@@ -1,7 +1,5 @@
# ChatStreamingMessageChunkRole # ChatStreamingMessageChunkRole
The role of the message author
## Values ## Values
@@ -1,13 +1,11 @@
# ChatStreamingMessageToolCall # ChatStreamingMessageToolCall
Tool call delta for streaming responses
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `index` | *float* | :heavy_check_mark: | Tool call index in the array | 0 | | `index` | *float* | :heavy_check_mark: | N/A |
| `id` | *Optional[str]* | :heavy_minus_sign: | Tool call identifier | call_abc123 | | `id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `type` | [Optional[components.ChatStreamingMessageToolCallType]](../components/chatstreamingmessagetoolcalltype.md) | :heavy_minus_sign: | Tool call type | function | | `type` | *Optional[Literal["function"]]* | :heavy_minus_sign: | N/A |
| `function` | [Optional[components.ChatStreamingMessageToolCallFunction]](../components/chatstreamingmessagetoolcallfunction.md) | :heavy_minus_sign: | Function call details | | | `function` | [Optional[components.ChatStreamingMessageToolCallFunction]](../components/chatstreamingmessagetoolcallfunction.md) | :heavy_minus_sign: | N/A |
@@ -1,11 +1,9 @@
# ChatStreamingMessageToolCallFunction # ChatStreamingMessageToolCallFunction
Function call details
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | | ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *Optional[str]* | :heavy_minus_sign: | Function name | get_weather | | `name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `arguments` | *Optional[str]* | :heavy_minus_sign: | Function arguments as JSON string | {"location": | | `arguments` | *Optional[str]* | :heavy_minus_sign: | N/A |
@@ -1,10 +0,0 @@
# ChatStreamingMessageToolCallType
Tool call type
## Values
| Name | Value |
| ---------- | ---------- |
| `FUNCTION` | function |
+3 -12
View File
@@ -1,17 +1,8 @@
# ChatStreamingResponseChunk # ChatStreamingResponseChunk
Streaming chat completion chunk
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | | `data` | [components.ChatStreamingResponseChunkData](../components/chatstreamingresponsechunkdata.md) | :heavy_check_mark: | N/A |
| `choices` | List[[components.ChatStreamingChoice](../components/chatstreamingchoice.md)] | :heavy_check_mark: | List of streaming chunk choices | |
| `created` | *float* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
| `object` | [components.ChatStreamingResponseChunkObject](../components/chatstreamingresponsechunkobject.md) | :heavy_check_mark: | N/A | |
| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb |
| `error` | [Optional[components.Error]](../components/error.md) | :heavy_minus_sign: | Error information | {<br/>"message": "Rate limit exceeded",<br/>"code": 429<br/>} |
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | Token usage statistics | {<br/>"completion_tokens": 15,<br/>"prompt_tokens": 10,<br/>"total_tokens": 25,<br/>"completion_tokens_details": {<br/>"reasoning_tokens": 5<br/>},<br/>"prompt_tokens_details": {<br/>"cached_tokens": 2<br/>}<br/>} |
@@ -0,0 +1,15 @@
# ChatStreamingResponseChunkData
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | N/A |
| `choices` | List[[components.ChatStreamingChoice](../components/chatstreamingchoice.md)] | :heavy_check_mark: | N/A |
| `created` | *float* | :heavy_check_mark: | N/A |
| `model` | *str* | :heavy_check_mark: | N/A |
| `object` | *Literal["chat.completion.chunk"]* | :heavy_check_mark: | N/A |
| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `error` | [Optional[components.ChatStreamingResponseChunkError]](../components/chatstreamingresponsechunkerror.md) | :heavy_minus_sign: | N/A |
| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | N/A |
@@ -1,9 +1,9 @@
# InputImageMask # ChatStreamingResponseChunkError
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ | | ------------------ | ------------------ | ------------------ | ------------------ |
| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | | `message` | *str* | :heavy_check_mark: | N/A |
| `file_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | `code` | *float* | :heavy_check_mark: | N/A |
@@ -1,8 +0,0 @@
# ChatStreamingResponseChunkObject
## Values
| Name | Value |
| ----------------------- | ----------------------- |
| `CHAT_COMPLETION_CHUNK` | chat.completion.chunk |
+3 -5
View File
@@ -1,10 +1,8 @@
# ChatStreamOptions # ChatStreamOptions
Streaming configuration options
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------ | ------------------ | ------------------ | ------------------ |
| ~~`include_usage`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated: This field has no effect. Full usage details are always included. | true | | `include_usage` | *Optional[bool]* | :heavy_minus_sign: | N/A |
+13 -21
View File
@@ -1,25 +1,17 @@
# Code # Code
## Values ## Supported Types
### `str`
```python
value: str = /* values here */
```
### `float`
```python
value: float = /* values here */
```
| Name | Value |
| -------------------------------- | -------------------------------- |
| `SERVER_ERROR` | server_error |
| `RATE_LIMIT_EXCEEDED` | rate_limit_exceeded |
| `INVALID_PROMPT` | invalid_prompt |
| `VECTOR_STORE_TIMEOUT` | vector_store_timeout |
| `INVALID_IMAGE` | invalid_image |
| `INVALID_IMAGE_FORMAT` | invalid_image_format |
| `INVALID_BASE64_IMAGE` | invalid_base64_image |
| `INVALID_IMAGE_URL` | invalid_image_url |
| `IMAGE_TOO_LARGE` | image_too_large |
| `IMAGE_TOO_SMALL` | image_too_small |
| `IMAGE_PARSE_ERROR` | image_parse_error |
| `IMAGE_CONTENT_POLICY_VIOLATION` | image_content_policy_violation |
| `INVALID_IMAGE_MODE` | invalid_image_mode |
| `IMAGE_FILE_TOO_LARGE` | image_file_too_large |
| `UNSUPPORTED_IMAGE_MEDIA_TYPE` | unsupported_image_media_type |
| `EMPTY_IMAGE_FILE` | empty_image_file |
| `FAILED_TO_DOWNLOAD_IMAGE` | failed_to_download_image |
| `IMAGE_FILE_NOT_FOUND` | image_file_not_found |
+25
View File
@@ -0,0 +1,25 @@
# CodeEnum
## Values
| Name | Value |
| -------------------------------- | -------------------------------- |
| `SERVER_ERROR` | server_error |
| `RATE_LIMIT_EXCEEDED` | rate_limit_exceeded |
| `INVALID_PROMPT` | invalid_prompt |
| `VECTOR_STORE_TIMEOUT` | vector_store_timeout |
| `INVALID_IMAGE` | invalid_image |
| `INVALID_IMAGE_FORMAT` | invalid_image_format |
| `INVALID_BASE64_IMAGE` | invalid_base64_image |
| `INVALID_IMAGE_URL` | invalid_image_url |
| `IMAGE_TOO_LARGE` | image_too_large |
| `IMAGE_TOO_SMALL` | image_too_small |
| `IMAGE_PARSE_ERROR` | image_parse_error |
| `IMAGE_CONTENT_POLICY_VIOLATION` | image_content_policy_violation |
| `INVALID_IMAGE_MODE` | invalid_image_mode |
| `IMAGE_FILE_TOO_LARGE` | image_file_too_large |
| `UNSUPPORTED_IMAGE_MEDIA_TYPE` | unsupported_image_media_type |
| `EMPTY_IMAGE_FILE` | empty_image_file |
| `FAILED_TO_DOWNLOAD_IMAGE` | failed_to_download_image |
| `IMAGE_FILE_NOT_FOUND` | image_file_not_found |
@@ -1,29 +1,23 @@
# Value2 # Completion
## Supported Types ## Supported Types
### `str`
```python
value: str = /* values here */
```
### `float` ### `float`
```python ```python
value: float = /* values here */ value: float = /* values here */
``` ```
### `bool` ### `str`
```python ```python
value: bool = /* values here */ value: str = /* values here */
``` ```
### `List[components.Value1]` ### `Any`
```python ```python
value: List[components.Value1] = /* values here */ value: Any = /* values here */
``` ```
+4 -6
View File
@@ -1,13 +1,11 @@
# CompletionTokensDetails # CompletionTokensDetails
Detailed completion token usage
## Fields ## Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `reasoning_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Tokens used for reasoning | | `reasoning_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `audio_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Tokens used for audio output | | `audio_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `accepted_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Accepted prediction tokens | | `accepted_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
| `rejected_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Rejected prediction tokens | | `rejected_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A |
-11
View File
@@ -1,11 +0,0 @@
# CompoundFilter
A compound filter that combines multiple comparison or compound filters
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `type` | [components.CompoundFilterType](../components/compoundfiltertype.md) | :heavy_check_mark: | N/A |
| `filters` | List[Dict[str, *Nullable[Any]*]] | :heavy_check_mark: | N/A |
-9
View File
@@ -1,9 +0,0 @@
# CompoundFilterType
## Values
| Name | Value |
| ----- | ----- |
| `AND` | and |
| `OR` | or |
-15
View File
@@ -1,15 +0,0 @@
# ConnectorID
## Values
| Name | Value |
| --------------------------- | --------------------------- |
| `CONNECTOR_DROPBOX` | connector_dropbox |
| `CONNECTOR_GMAIL` | connector_gmail |
| `CONNECTOR_GOOGLECALENDAR` | connector_googlecalendar |
| `CONNECTOR_GOOGLEDRIVE` | connector_googledrive |
| `CONNECTOR_MICROSOFTTEAMS` | connector_microsoftteams |
| `CONNECTOR_OUTLOOKCALENDAR` | connector_outlookcalendar |
| `CONNECTOR_OUTLOOKEMAIL` | connector_outlookemail |
| `CONNECTOR_SHAREPOINT` | connector_sharepoint |
-10
View File
@@ -1,10 +0,0 @@
# ContainerAuto
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `type` | [components.ContainerType](../components/containertype.md) | :heavy_check_mark: | N/A |
| `file_ids` | List[*str*] | :heavy_minus_sign: | N/A |
| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.md) | :heavy_minus_sign: | N/A |
-8
View File
@@ -1,8 +0,0 @@
# ContainerType
## Values
| Name | Value |
| ------ | ------ |
| `AUTO` | auto |
+8
View File
@@ -0,0 +1,8 @@
# Debug
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `echo_upstream_body` | *Optional[bool]* | :heavy_minus_sign: | N/A |
-10
View File
@@ -1,10 +0,0 @@
# DebugOptions
Debug options for inspecting request transformations (streaming only)
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `echo_upstream_body` | *Optional[bool]* | :heavy_minus_sign: | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true |

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