@openrouter/sdk 0.8.0 → 0.10.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +2 -1
- package/_speakeasy/.github/action-inputs-config.json +4 -0
- package/esm/funcs/analyticsGetUserActivity.js +2 -1
- package/esm/funcs/apiKeysCreate.js +2 -1
- package/esm/funcs/apiKeysDelete.js +2 -1
- package/esm/funcs/apiKeysGet.js +2 -1
- package/esm/funcs/apiKeysGetCurrentKeyMetadata.js +2 -1
- package/esm/funcs/apiKeysList.js +2 -1
- package/esm/funcs/apiKeysUpdate.js +2 -1
- package/esm/funcs/betaResponsesSend.js +2 -1
- package/esm/funcs/call-model.d.ts +19 -70
- package/esm/funcs/call-model.js +29 -71
- package/esm/funcs/chatSend.d.ts +3 -3
- package/esm/funcs/chatSend.js +20 -3
- package/esm/funcs/creditsCreateCoinbaseCharge.js +2 -1
- package/esm/funcs/creditsGetCredits.js +2 -1
- package/esm/funcs/embeddingsGenerate.js +2 -1
- package/esm/funcs/embeddingsListModels.js +2 -1
- package/esm/funcs/endpointsList.js +2 -1
- package/esm/funcs/endpointsListZdrEndpoints.js +2 -1
- package/esm/funcs/generationsGetGeneration.js +2 -1
- package/esm/funcs/guardrailsBulkAssignKeys.js +2 -1
- package/esm/funcs/guardrailsBulkAssignMembers.js +2 -1
- package/esm/funcs/guardrailsBulkUnassignKeys.js +2 -1
- package/esm/funcs/guardrailsBulkUnassignMembers.js +2 -1
- package/esm/funcs/guardrailsCreate.js +2 -1
- package/esm/funcs/guardrailsDelete.js +2 -1
- package/esm/funcs/guardrailsGet.js +2 -1
- package/esm/funcs/guardrailsList.js +2 -1
- package/esm/funcs/guardrailsListGuardrailKeyAssignments.js +2 -1
- package/esm/funcs/guardrailsListGuardrailMemberAssignments.js +2 -1
- package/esm/funcs/guardrailsListKeyAssignments.js +2 -1
- package/esm/funcs/guardrailsListMemberAssignments.js +2 -1
- package/esm/funcs/guardrailsUpdate.js +2 -1
- package/esm/funcs/modelsCount.d.ts +1 -1
- package/esm/funcs/modelsCount.js +9 -4
- package/esm/funcs/modelsList.js +3 -1
- package/esm/funcs/modelsListForUser.js +2 -1
- package/esm/funcs/oAuthCreateAuthCode.d.ts +1 -1
- package/esm/funcs/oAuthCreateAuthCode.js +4 -3
- package/esm/funcs/oAuthExchangeAuthCodeForAPIKey.js +2 -1
- package/esm/funcs/providersList.js +2 -1
- package/esm/index.d.ts +22 -23
- package/esm/index.js +20 -17
- package/esm/lib/anthropic-compat.d.ts +2 -1
- package/esm/lib/anthropic-compat.js +1 -2
- package/esm/lib/async-params.d.ts +19 -5
- package/esm/lib/async-params.js +5 -1
- package/esm/lib/chat-compat.d.ts +1 -1
- package/esm/lib/chat-compat.js +1 -2
- package/esm/lib/claude-type-guards.d.ts +2 -2
- package/esm/lib/config.d.ts +8 -10
- package/esm/lib/config.js +2 -2
- package/esm/lib/conversation-state.d.ts +1 -1
- package/esm/lib/conversation-state.js +35 -32
- package/esm/lib/env.d.ts +6 -2
- package/esm/lib/env.js +7 -3
- package/esm/lib/model-result.d.ts +73 -17
- package/esm/lib/model-result.js +329 -125
- package/esm/lib/sdks.d.ts +1 -1
- package/esm/lib/sdks.js +8 -28
- package/esm/lib/stream-transformers.d.ts +5 -4
- package/esm/lib/stream-transformers.js +24 -29
- package/esm/lib/stream-type-guards.js +8 -32
- package/esm/lib/tool-context.d.ts +68 -0
- package/esm/lib/tool-context.js +175 -0
- package/esm/lib/tool-executor.d.ts +9 -5
- package/esm/lib/tool-executor.js +26 -16
- package/esm/lib/tool-orchestrator.d.ts +2 -2
- package/esm/lib/tool-types.d.ts +101 -14
- package/esm/lib/tool-types.js +17 -0
- package/esm/lib/tool.d.ts +49 -60
- package/esm/lib/tool.js +15 -19
- package/esm/lib/turn-context.d.ts +1 -1
- package/esm/models/assistantmessage.d.ts +53 -36
- package/esm/models/assistantmessage.js +38 -47
- package/esm/models/assistantmessageimages.d.ts +33 -0
- package/esm/models/assistantmessageimages.js +44 -0
- package/esm/models/chatcompletionaudiooutput.d.ts +38 -0
- package/esm/models/chatcompletionaudiooutput.js +36 -0
- package/esm/models/chatgenerationparams.d.ts +527 -131
- package/esm/models/chatgenerationparams.js +280 -97
- package/esm/models/chatgenerationtokenusage.d.ts +48 -0
- package/esm/models/chatmessagecontentitem.d.ts +16 -10
- package/esm/models/chatmessagecontentitem.js +28 -4
- package/esm/models/chatmessagecontentitemaudio.d.ts +20 -2
- package/esm/models/chatmessagecontentitemaudio.js +9 -2
- package/esm/models/chatmessagecontentitemcachecontrol.d.ts +19 -8
- package/esm/models/chatmessagecontentitemcachecontrol.js +14 -9
- package/esm/models/chatmessagecontentitemfile.d.ts +57 -0
- package/esm/models/chatmessagecontentitemfile.js +59 -0
- package/esm/models/chatmessagecontentitemimage.d.ts +26 -3
- package/esm/models/chatmessagecontentitemimage.js +12 -2
- package/esm/models/chatmessagecontentitemtext.d.ts +17 -2
- package/esm/models/chatmessagecontentitemtext.js +9 -2
- package/esm/models/chatmessagecontentitemvideo.d.ts +12 -55
- package/esm/models/chatmessagecontentitemvideo.js +5 -72
- package/esm/models/chatmessagecontentitemvideolegacy.d.ts +28 -0
- package/esm/models/chatmessagecontentitemvideolegacy.js +33 -0
- package/esm/models/chatmessagetokenlogprob.d.ts +15 -0
- package/esm/models/chatmessagetokenlogprobs.d.ts +10 -1
- package/esm/models/chatmessagetokenlogprobs.js +2 -1
- package/esm/models/chatmessagetoolcall.d.ts +23 -2
- package/esm/models/chatmessagetoolcall.js +9 -2
- package/esm/models/chatresponse.d.ts +30 -2
- package/esm/models/chatresponse.js +7 -2
- package/esm/models/chatresponsechoice.d.ts +13 -2
- package/esm/models/chatresponsechoice.js +1 -2
- package/esm/models/chatstreamingchoice.d.ts +13 -2
- package/esm/models/chatstreamingchoice.js +1 -2
- package/esm/models/chatstreamingmessagechunk.d.ts +31 -2
- package/esm/models/chatstreamingmessagechunk.js +7 -2
- package/esm/models/chatstreamingmessagetoolcall.d.ts +38 -1
- package/esm/models/chatstreamingmessagetoolcall.js +9 -1
- package/esm/models/chatstreamingresponsechunk.d.ts +46 -12
- package/esm/models/chatstreamingresponsechunk.js +12 -26
- package/esm/models/chatstreamoptions.d.ts +8 -0
- package/esm/models/compoundfilter.d.ts +36 -0
- package/esm/models/compoundfilter.js +32 -0
- package/esm/models/conflictresponseerrordata.d.ts +17 -0
- package/esm/models/conflictresponseerrordata.js +16 -0
- package/esm/models/contextcompressionengine.d.ts +15 -0
- package/esm/models/contextcompressionengine.js +14 -0
- package/esm/models/datetimeservertool.d.ts +30 -0
- package/esm/models/datetimeservertool.js +22 -0
- package/esm/models/debugoptions.d.ts +18 -0
- package/esm/models/debugoptions.js +18 -0
- package/esm/models/defaultparameters.d.ts +3 -0
- package/esm/models/defaultparameters.js +6 -0
- package/esm/models/developermessage.d.ts +12 -0
- package/esm/models/errors/conflictresponseerror.d.ts +33 -0
- package/esm/models/errors/{chaterror.js → conflictresponseerror.js} +17 -7
- package/esm/models/errors/index.d.ts +1 -1
- package/esm/models/errors/index.js +1 -1
- package/esm/models/index.d.ts +35 -12
- package/esm/models/index.js +35 -12
- package/esm/models/jsonschemaconfig.d.ts +17 -2
- package/esm/models/jsonschemaconfig.js +1 -1
- package/esm/models/message.d.ts +9 -2
- package/esm/models/message.js +1 -1
- package/esm/models/modelscountresponse.d.ts +4 -4
- package/esm/models/modelscountresponse.js +4 -4
- package/esm/models/namedtoolchoice.d.ts +15 -2
- package/esm/models/namedtoolchoice.js +6 -1
- package/esm/models/openairesponsesinputunion.d.ts +32 -1
- package/esm/models/openairesponsesinputunion.js +53 -1
- package/esm/models/openairesponsesreasoningconfig.d.ts +1 -1
- package/esm/models/openairesponsesreasoningconfig.js +1 -1
- package/esm/models/openresponsesapplypatchtool.d.ts +20 -0
- package/esm/models/openresponsesapplypatchtool.js +21 -0
- package/esm/models/openresponsescodeinterpretertool.d.ts +68 -0
- package/esm/models/openresponsescodeinterpretertool.js +85 -0
- package/esm/models/openresponsescomputertool.d.ts +39 -0
- package/esm/models/openresponsescomputertool.js +50 -0
- package/esm/models/openresponsescustomtool.d.ts +75 -0
- package/esm/models/openresponsescustomtool.js +95 -0
- package/esm/models/openresponseseasyinputmessage.d.ts +30 -4
- package/esm/models/openresponseseasyinputmessage.js +28 -2
- package/esm/models/openresponsesfilesearchtool.d.ts +111 -0
- package/esm/models/openresponsesfilesearchtool.js +180 -0
- package/esm/models/openresponsesfunctioncalloutput.d.ts +46 -7
- package/esm/models/openresponsesfunctioncalloutput.js +56 -4
- package/esm/models/openresponsesfunctionshelltool.d.ts +20 -0
- package/esm/models/openresponsesfunctionshelltool.js +21 -0
- package/esm/models/openresponsesimagegenerationtool.d.ts +125 -0
- package/esm/models/openresponsesimagegenerationtool.js +153 -0
- package/esm/models/openresponsesinputmessageitem.d.ts +2 -2
- package/esm/models/openresponsesinputmessageitem.js +2 -2
- package/esm/models/openresponsesinputunion.d.ts +207 -0
- package/esm/models/openresponsesinputunion.js +225 -0
- package/esm/models/openresponseslocalshelltool.d.ts +20 -0
- package/esm/models/openresponseslocalshelltool.js +21 -0
- package/esm/models/openresponsesmcptool.d.ts +128 -0
- package/esm/models/openresponsesmcptool.js +173 -0
- package/esm/models/openresponsesnonstreamingresponse.d.ts +15 -6
- package/esm/models/openresponsesnonstreamingresponse.js +30 -3
- package/esm/models/openresponsesreasoning.d.ts +2 -2
- package/esm/models/openresponsesreasoning.js +1 -1
- package/esm/models/openresponsesreasoningconfig.d.ts +2 -2
- package/esm/models/openresponsesreasoningconfig.js +1 -1
- package/esm/models/openresponsesrequest.d.ts +111 -39
- package/esm/models/openresponsesrequest.js +112 -38
- package/esm/models/openresponsesstreamevent.d.ts +52 -4
- package/esm/models/openresponsesstreamevent.js +54 -3
- package/esm/models/openresponseswebsearch20250826tool.d.ts +29 -0
- package/esm/models/openresponseswebsearch20250826tool.js +23 -0
- package/esm/models/openresponseswebsearchcallcompleted.d.ts +16 -0
- package/esm/models/openresponseswebsearchcallcompleted.js +24 -0
- package/esm/models/openresponseswebsearchcallinprogress.d.ts +16 -0
- package/esm/models/openresponseswebsearchcallinprogress.js +24 -0
- package/esm/models/openresponseswebsearchcallsearching.d.ts +16 -0
- package/esm/models/openresponseswebsearchcallsearching.js +24 -0
- package/esm/models/openresponseswebsearchpreview20250311tool.d.ts +44 -0
- package/esm/models/openresponseswebsearchpreview20250311tool.js +51 -0
- package/esm/models/openresponseswebsearchpreviewtool.d.ts +44 -0
- package/esm/models/openresponseswebsearchpreviewtool.js +47 -0
- package/esm/models/openresponseswebsearchtool.d.ts +29 -0
- package/esm/models/openresponseswebsearchtool.js +23 -0
- package/esm/models/operations/bulkassignkeystoguardrail.d.ts +16 -3
- package/esm/models/operations/bulkassignkeystoguardrail.js +2 -2
- package/esm/models/operations/bulkassignmemberstoguardrail.d.ts +16 -3
- package/esm/models/operations/bulkassignmemberstoguardrail.js +2 -2
- package/esm/models/operations/bulkunassignkeysfromguardrail.d.ts +16 -3
- package/esm/models/operations/bulkunassignkeysfromguardrail.js +2 -2
- package/esm/models/operations/bulkunassignmembersfromguardrail.d.ts +16 -3
- package/esm/models/operations/bulkunassignmembersfromguardrail.js +2 -2
- package/esm/models/operations/createauthkeyscode.d.ts +40 -3
- package/esm/models/operations/createauthkeyscode.js +16 -2
- package/esm/models/operations/createcoinbasecharge.d.ts +16 -3
- package/esm/models/operations/createcoinbasecharge.js +2 -2
- package/esm/models/operations/createembeddings.d.ts +16 -3
- package/esm/models/operations/createembeddings.js +2 -2
- package/esm/models/operations/createguardrail.d.ts +25 -3
- package/esm/models/operations/createguardrail.js +6 -2
- package/esm/models/operations/createkeys.d.ts +16 -3
- package/esm/models/operations/createkeys.js +2 -2
- package/esm/models/operations/createresponses.d.ts +16 -3
- package/esm/models/operations/createresponses.js +2 -2
- package/esm/models/operations/deleteguardrail.d.ts +16 -3
- package/esm/models/operations/deleteguardrail.js +2 -2
- package/esm/models/operations/deletekeys.d.ts +16 -3
- package/esm/models/operations/deletekeys.js +2 -2
- package/esm/models/operations/exchangeauthcodeforapikey.d.ts +16 -3
- package/esm/models/operations/exchangeauthcodeforapikey.js +2 -2
- package/esm/models/operations/getcredits.d.ts +16 -3
- package/esm/models/operations/getcredits.js +2 -2
- package/esm/models/operations/getcurrentkey.d.ts +16 -3
- package/esm/models/operations/getcurrentkey.js +2 -2
- package/esm/models/operations/getgeneration.d.ts +27 -3
- package/esm/models/operations/getgeneration.js +9 -2
- package/esm/models/operations/getguardrail.d.ts +20 -3
- package/esm/models/operations/getguardrail.js +4 -2
- package/esm/models/operations/getkey.d.ts +16 -3
- package/esm/models/operations/getkey.js +2 -2
- package/esm/models/operations/getmodels.d.ts +21 -3
- package/esm/models/operations/getmodels.js +4 -2
- package/esm/models/operations/getuseractivity.d.ts +16 -3
- package/esm/models/operations/getuseractivity.js +2 -2
- package/esm/models/operations/list.d.ts +16 -3
- package/esm/models/operations/list.js +2 -2
- package/esm/models/operations/listembeddingsmodels.d.ts +16 -3
- package/esm/models/operations/listembeddingsmodels.js +2 -2
- package/esm/models/operations/listendpoints.d.ts +16 -3
- package/esm/models/operations/listendpoints.js +2 -2
- package/esm/models/operations/listendpointszdr.d.ts +16 -3
- package/esm/models/operations/listendpointszdr.js +2 -2
- package/esm/models/operations/listguardrailkeyassignments.d.ts +16 -3
- package/esm/models/operations/listguardrailkeyassignments.js +2 -2
- package/esm/models/operations/listguardrailmemberassignments.d.ts +16 -3
- package/esm/models/operations/listguardrailmemberassignments.js +2 -2
- package/esm/models/operations/listguardrails.d.ts +20 -3
- package/esm/models/operations/listguardrails.js +4 -2
- package/esm/models/operations/listkeyassignments.d.ts +16 -3
- package/esm/models/operations/listkeyassignments.js +2 -2
- package/esm/models/operations/listmemberassignments.d.ts +16 -3
- package/esm/models/operations/listmemberassignments.js +2 -2
- package/esm/models/operations/listmodelscount.d.ts +21 -3
- package/esm/models/operations/listmodelscount.js +4 -2
- package/esm/models/operations/listmodelsuser.d.ts +16 -3
- package/esm/models/operations/listmodelsuser.js +2 -2
- package/esm/models/operations/listproviders.d.ts +16 -3
- package/esm/models/operations/listproviders.js +2 -2
- package/esm/models/operations/sendchatcompletionrequest.d.ts +27 -5
- package/esm/models/operations/sendchatcompletionrequest.js +22 -4
- package/esm/models/operations/updateguardrail.d.ts +25 -3
- package/esm/models/operations/updateguardrail.js +6 -2
- package/esm/models/operations/updatekeys.d.ts +16 -3
- package/esm/models/operations/updatekeys.js +2 -2
- package/esm/models/outputmessage.d.ts +23 -0
- package/esm/models/outputmessage.js +24 -0
- package/esm/models/outputmodality.d.ts +1 -0
- package/esm/models/outputmodality.js +1 -0
- package/esm/models/providername.d.ts +3 -0
- package/esm/models/providername.js +3 -0
- package/esm/models/providerpreferences.d.ts +49 -14
- package/esm/models/providerpreferences.js +33 -15
- package/esm/models/providersort.d.ts +7 -0
- package/esm/models/providersort.js +4 -0
- package/esm/models/providersortconfig.d.ts +31 -2
- package/esm/models/providersortconfig.js +16 -2
- package/esm/models/reasoningdetailencrypted.d.ts +42 -0
- package/esm/models/reasoningdetailencrypted.js +42 -0
- package/esm/models/reasoningdetailsummary.d.ts +42 -0
- package/esm/models/reasoningdetailsummary.js +42 -0
- package/esm/models/reasoningdetailtext.d.ts +44 -0
- package/esm/models/reasoningdetailtext.js +44 -0
- package/esm/models/reasoningdetailunion.d.ts +19 -0
- package/esm/models/reasoningdetailunion.js +28 -0
- package/esm/models/responseformatjsonobject.d.ts +20 -0
- package/esm/models/responseformatjsonobject.js +21 -0
- package/esm/models/responseformatjsonschema.d.ts +6 -0
- package/esm/models/responseformattext.d.ts +15 -0
- package/esm/models/responseformattext.js +13 -0
- package/esm/models/responseformattextconfig.d.ts +3 -3
- package/esm/models/responseformattextconfig.js +3 -3
- package/esm/models/responseformattextgrammar.d.ts +6 -0
- package/esm/models/responseformattextpython.d.ts +15 -0
- package/esm/models/responseformattextpython.js +13 -0
- package/esm/models/responseoutputtext.d.ts +8 -8
- package/esm/models/responseoutputtext.js +10 -9
- package/esm/models/responseserrorfield.d.ts +4 -4
- package/esm/models/responseserrorfield.js +4 -4
- package/esm/models/responsesoutputitem.d.ts +2 -13
- package/esm/models/responsesoutputitem.js +8 -6
- package/esm/models/responsesoutputitemreasoning.d.ts +3 -32
- package/esm/models/responsesoutputitemreasoning.js +3 -45
- package/esm/models/responsesoutputmessage.d.ts +24 -32
- package/esm/models/responsesoutputmessage.js +26 -47
- package/esm/models/responsesservertooloutput.d.ts +42 -0
- package/esm/models/responsesservertooloutput.js +44 -0
- package/esm/models/responseswebsearchcalloutput.d.ts +90 -5
- package/esm/models/responseswebsearchcalloutput.js +113 -5
- package/esm/models/responseswebsearchservertool.d.ts +35 -0
- package/esm/models/responseswebsearchservertool.js +28 -0
- package/esm/models/systemmessage.d.ts +12 -0
- package/esm/models/toolchoiceoption.d.ts +31 -0
- package/esm/models/toolchoiceoption.js +32 -0
- package/esm/models/tooldefinitionjson.d.ts +62 -10
- package/esm/models/tooldefinitionjson.js +29 -6
- package/esm/models/toolresponsemessage.d.ts +12 -0
- package/esm/models/usermessage.d.ts +12 -0
- package/esm/models/videoinput.d.ts +23 -0
- package/esm/models/videoinput.js +22 -0
- package/esm/models/websearchengine.d.ts +2 -0
- package/esm/models/websearchengine.js +2 -0
- package/esm/models/websearchservertool.d.ts +116 -0
- package/esm/models/websearchservertool.js +77 -0
- package/esm/models/websearchshorthand.d.ts +215 -0
- package/esm/models/websearchshorthand.js +138 -0
- package/esm/sdk/chat.d.ts +1 -1
- package/esm/sdk/sdk.d.ts +6 -3
- package/esm/sdk/sdk.js +3 -4
- package/esm/types/index.d.ts +0 -2
- package/esm/types/index.js +0 -1
- package/jsr.json +1 -1
- package/package.json +11 -6
- package/turbo.json +10 -0
- package/esm/models/chaterror.d.ts +0 -17
- package/esm/models/chaterror.js +0 -25
- package/esm/models/errors/chaterror.d.ts +0 -19
- package/esm/models/openresponsesinput.d.ts +0 -28
- package/esm/models/openresponsesinput.js +0 -54
- package/esm/models/openresponseslogprobs.d.ts +0 -16
- package/esm/models/openresponseslogprobs.js +0 -22
- package/esm/models/openresponsestoplogprobs.d.ts +0 -14
- package/esm/models/openresponsestoplogprobs.js +0 -15
- package/esm/models/providersortunion.d.ts +0 -10
- package/esm/models/providersortunion.js +0 -13
- package/esm/models/responsesformatjsonobject.d.ts +0 -20
- package/esm/models/responsesformatjsonobject.js +0 -21
- package/esm/models/schema10.d.ts +0 -33
- package/esm/models/schema10.js +0 -30
- package/esm/models/schema14.d.ts +0 -8
- package/esm/models/schema14.js +0 -12
- package/esm/models/schema17.d.ts +0 -102
- package/esm/models/schema17.js +0 -95
- package/esm/models/schema19.d.ts +0 -92
- package/esm/models/schema19.js +0 -109
- package/esm/models/schema5.d.ts +0 -86
- package/esm/models/schema5.js +0 -89
|
@@ -1,59 +1,249 @@
|
|
|
1
1
|
import * as z from "zod/v4";
|
|
2
|
-
import { OpenEnum } from "../types/enums.js";
|
|
2
|
+
import { ClosedEnum, OpenEnum } from "../types/enums.js";
|
|
3
3
|
import { ChatStreamOptions, ChatStreamOptions$Outbound } from "./chatstreamoptions.js";
|
|
4
|
+
import { ContextCompressionEngine } from "./contextcompressionengine.js";
|
|
5
|
+
import { DataCollection } from "./datacollection.js";
|
|
6
|
+
import { DebugOptions, DebugOptions$Outbound } from "./debugoptions.js";
|
|
4
7
|
import { Message, Message$Outbound } from "./message.js";
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
8
|
+
import { PDFParserOptions, PDFParserOptions$Outbound } from "./pdfparseroptions.js";
|
|
9
|
+
import { PreferredMaxLatency, PreferredMaxLatency$Outbound } from "./preferredmaxlatency.js";
|
|
10
|
+
import { PreferredMinThroughput, PreferredMinThroughput$Outbound } from "./preferredminthroughput.js";
|
|
11
|
+
import { ProviderName } from "./providername.js";
|
|
12
|
+
import { Quantization } from "./quantization.js";
|
|
13
|
+
import { ResponseFormatJSONObject, ResponseFormatJSONObject$Outbound } from "./responseformatjsonobject.js";
|
|
7
14
|
import { ResponseFormatJSONSchema, ResponseFormatJSONSchema$Outbound } from "./responseformatjsonschema.js";
|
|
15
|
+
import { ResponseFormatText, ResponseFormatText$Outbound } from "./responseformattext.js";
|
|
8
16
|
import { ResponseFormatTextGrammar, ResponseFormatTextGrammar$Outbound } from "./responseformattextgrammar.js";
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import { Schema5, Schema5$Outbound } from "./schema5.js";
|
|
17
|
+
import { ResponseFormatTextPython, ResponseFormatTextPython$Outbound } from "./responseformattextpython.js";
|
|
18
|
+
import { ToolChoiceOption, ToolChoiceOption$Outbound } from "./toolchoiceoption.js";
|
|
12
19
|
import { ToolDefinitionJson, ToolDefinitionJson$Outbound } from "./tooldefinitionjson.js";
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
export
|
|
18
|
-
|
|
19
|
-
readonly
|
|
20
|
-
readonly
|
|
21
|
-
readonly
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
readonly
|
|
26
|
-
readonly
|
|
27
|
-
readonly
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
export type
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
20
|
+
import { WebSearchEngine } from "./websearchengine.js";
|
|
21
|
+
export type ChatGenerationParamsOrder = ProviderName | string;
|
|
22
|
+
export type ChatGenerationParamsOnly = ProviderName | string;
|
|
23
|
+
export type ChatGenerationParamsIgnore = ProviderName | string;
|
|
24
|
+
export declare const ChatGenerationParamsSortEnum: {
|
|
25
|
+
readonly Price: "price";
|
|
26
|
+
readonly Throughput: "throughput";
|
|
27
|
+
readonly Latency: "latency";
|
|
28
|
+
readonly Exacto: "exacto";
|
|
29
|
+
};
|
|
30
|
+
export type ChatGenerationParamsSortEnum = OpenEnum<typeof ChatGenerationParamsSortEnum>;
|
|
31
|
+
export declare const ChatGenerationParamsProviderSortConfigEnum: {
|
|
32
|
+
readonly Price: "price";
|
|
33
|
+
readonly Throughput: "throughput";
|
|
34
|
+
readonly Latency: "latency";
|
|
35
|
+
readonly Exacto: "exacto";
|
|
36
|
+
};
|
|
37
|
+
export type ChatGenerationParamsProviderSortConfigEnum = ClosedEnum<typeof ChatGenerationParamsProviderSortConfigEnum>;
|
|
38
|
+
/**
|
|
39
|
+
* The provider sorting strategy (price, throughput, latency)
|
|
40
|
+
*/
|
|
41
|
+
export declare const ChatGenerationParamsBy: {
|
|
42
|
+
readonly Price: "price";
|
|
43
|
+
readonly Throughput: "throughput";
|
|
44
|
+
readonly Latency: "latency";
|
|
45
|
+
readonly Exacto: "exacto";
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* The provider sorting strategy (price, throughput, latency)
|
|
49
|
+
*/
|
|
50
|
+
export type ChatGenerationParamsBy = OpenEnum<typeof ChatGenerationParamsBy>;
|
|
51
|
+
/**
|
|
52
|
+
* Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model.
|
|
53
|
+
*/
|
|
54
|
+
export declare const ChatGenerationParamsPartition: {
|
|
55
|
+
readonly Model: "model";
|
|
56
|
+
readonly None: "none";
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model.
|
|
60
|
+
*/
|
|
61
|
+
export type ChatGenerationParamsPartition = OpenEnum<typeof ChatGenerationParamsPartition>;
|
|
62
|
+
export type ChatGenerationParamsProviderSortConfig = {
|
|
63
|
+
/**
|
|
64
|
+
* The provider sorting strategy (price, throughput, latency)
|
|
65
|
+
*/
|
|
66
|
+
by?: ChatGenerationParamsBy | null | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model.
|
|
69
|
+
*/
|
|
70
|
+
partition?: ChatGenerationParamsPartition | null | undefined;
|
|
71
|
+
};
|
|
72
|
+
export type ChatGenerationParamsProviderSortConfigUnion = ChatGenerationParamsProviderSortConfig | ChatGenerationParamsProviderSortConfigEnum;
|
|
73
|
+
/**
|
|
74
|
+
* The provider sorting strategy (price, throughput, latency)
|
|
75
|
+
*/
|
|
76
|
+
export declare const ChatGenerationParamsProviderSort: {
|
|
77
|
+
readonly Price: "price";
|
|
78
|
+
readonly Throughput: "throughput";
|
|
79
|
+
readonly Latency: "latency";
|
|
80
|
+
readonly Exacto: "exacto";
|
|
81
|
+
};
|
|
82
|
+
/**
|
|
83
|
+
* The provider sorting strategy (price, throughput, latency)
|
|
84
|
+
*/
|
|
85
|
+
export type ChatGenerationParamsProviderSort = OpenEnum<typeof ChatGenerationParamsProviderSort>;
|
|
86
|
+
/**
|
|
87
|
+
* The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed.
|
|
88
|
+
*/
|
|
89
|
+
export type ChatGenerationParamsSortUnion = ChatGenerationParamsProviderSort | ChatGenerationParamsProviderSortConfig | ChatGenerationParamsProviderSortConfigEnum | ChatGenerationParamsSortEnum;
|
|
90
|
+
/**
|
|
91
|
+
* The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.
|
|
92
|
+
*/
|
|
93
|
+
export type ChatGenerationParamsMaxPrice = {
|
|
94
|
+
/**
|
|
95
|
+
* Price per million prompt tokens
|
|
96
|
+
*/
|
|
97
|
+
prompt?: string | undefined;
|
|
98
|
+
completion?: string | undefined;
|
|
99
|
+
image?: string | undefined;
|
|
100
|
+
audio?: string | undefined;
|
|
101
|
+
request?: string | undefined;
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* When multiple model providers are available, optionally indicate your routing preference.
|
|
105
|
+
*/
|
|
106
|
+
export type ChatGenerationParamsProvider = {
|
|
107
|
+
/**
|
|
108
|
+
* Whether to allow backup providers to serve requests
|
|
109
|
+
*
|
|
110
|
+
* @remarks
|
|
111
|
+
* - true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
|
|
112
|
+
* - false: use only the primary/custom provider, and return the upstream error if it's unavailable.
|
|
113
|
+
*/
|
|
38
114
|
allowFallbacks?: boolean | null | undefined;
|
|
115
|
+
/**
|
|
116
|
+
* 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.
|
|
117
|
+
*/
|
|
39
118
|
requireParameters?: boolean | null | undefined;
|
|
40
|
-
|
|
119
|
+
/**
|
|
120
|
+
* Data collection setting. If no available model provider meets the requirement, your request will return an error.
|
|
121
|
+
*
|
|
122
|
+
* @remarks
|
|
123
|
+
* - allow: (default) allow providers which store user data non-transiently and may train on it
|
|
124
|
+
*
|
|
125
|
+
* - deny: use only providers which do not collect user data.
|
|
126
|
+
*/
|
|
127
|
+
dataCollection?: DataCollection | null | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used.
|
|
130
|
+
*/
|
|
41
131
|
zdr?: boolean | null | undefined;
|
|
132
|
+
/**
|
|
133
|
+
* Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used.
|
|
134
|
+
*/
|
|
42
135
|
enforceDistillableText?: boolean | null | undefined;
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
136
|
+
/**
|
|
137
|
+
* 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.
|
|
138
|
+
*/
|
|
139
|
+
order?: Array<ProviderName | string> | null | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request.
|
|
142
|
+
*/
|
|
143
|
+
only?: Array<ProviderName | string> | null | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request.
|
|
146
|
+
*/
|
|
147
|
+
ignore?: Array<ProviderName | string> | null | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* A list of quantization levels to filter the provider by.
|
|
150
|
+
*/
|
|
151
|
+
quantizations?: Array<Quantization> | null | undefined;
|
|
152
|
+
sort?: ChatGenerationParamsProviderSort | ChatGenerationParamsProviderSortConfig | ChatGenerationParamsProviderSortConfigEnum | ChatGenerationParamsSortEnum | null | undefined;
|
|
153
|
+
/**
|
|
154
|
+
* The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion.
|
|
155
|
+
*/
|
|
156
|
+
maxPrice?: ChatGenerationParamsMaxPrice | undefined;
|
|
157
|
+
/**
|
|
158
|
+
* 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.
|
|
159
|
+
*/
|
|
160
|
+
preferredMinThroughput?: PreferredMinThroughput | null | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* 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.
|
|
163
|
+
*/
|
|
164
|
+
preferredMaxLatency?: PreferredMaxLatency | null | undefined;
|
|
165
|
+
};
|
|
166
|
+
export type ChatGenerationParamsPluginContextCompression = {
|
|
167
|
+
id: "context-compression";
|
|
168
|
+
/**
|
|
169
|
+
* Set to false to disable the context-compression plugin for this request. Defaults to true.
|
|
170
|
+
*/
|
|
171
|
+
enabled?: boolean | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* The compression engine to use. Defaults to "middle-out".
|
|
174
|
+
*/
|
|
175
|
+
engine?: ContextCompressionEngine | undefined;
|
|
176
|
+
};
|
|
177
|
+
export type ChatGenerationParamsPluginResponseHealing = {
|
|
178
|
+
id: "response-healing";
|
|
179
|
+
/**
|
|
180
|
+
* Set to false to disable the response-healing plugin for this request. Defaults to true.
|
|
181
|
+
*/
|
|
182
|
+
enabled?: boolean | undefined;
|
|
183
|
+
};
|
|
184
|
+
export type ChatGenerationParamsPluginFileParser = {
|
|
185
|
+
id: "file-parser";
|
|
186
|
+
/**
|
|
187
|
+
* Set to false to disable the file-parser plugin for this request. Defaults to true.
|
|
188
|
+
*/
|
|
189
|
+
enabled?: boolean | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* Options for PDF parsing.
|
|
192
|
+
*/
|
|
193
|
+
pdf?: PDFParserOptions | undefined;
|
|
194
|
+
};
|
|
195
|
+
export type ChatGenerationParamsPluginWeb = {
|
|
196
|
+
id: "web";
|
|
197
|
+
/**
|
|
198
|
+
* Set to false to disable the web-search plugin for this request. Defaults to true.
|
|
199
|
+
*/
|
|
200
|
+
enabled?: boolean | undefined;
|
|
201
|
+
maxResults?: number | undefined;
|
|
202
|
+
searchPrompt?: string | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* The search engine to use for web search.
|
|
205
|
+
*/
|
|
206
|
+
engine?: WebSearchEngine | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").
|
|
209
|
+
*/
|
|
210
|
+
includeDomains?: Array<string> | undefined;
|
|
211
|
+
/**
|
|
212
|
+
* A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").
|
|
213
|
+
*/
|
|
214
|
+
excludeDomains?: Array<string> | undefined;
|
|
215
|
+
};
|
|
216
|
+
export type ChatGenerationParamsPluginModeration = {
|
|
217
|
+
id: "moderation";
|
|
218
|
+
};
|
|
219
|
+
export type ChatGenerationParamsPluginAutoRouter = {
|
|
220
|
+
id: "auto-router";
|
|
221
|
+
/**
|
|
222
|
+
* Set to false to disable the auto-router plugin for this request. Defaults to true.
|
|
223
|
+
*/
|
|
224
|
+
enabled?: boolean | undefined;
|
|
225
|
+
/**
|
|
226
|
+
* List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). When not specified, uses the default supported models list.
|
|
227
|
+
*/
|
|
228
|
+
allowedModels?: Array<string> | undefined;
|
|
229
|
+
};
|
|
230
|
+
export type ChatGenerationParamsPluginUnion = ChatGenerationParamsPluginAutoRouter | ChatGenerationParamsPluginModeration | ChatGenerationParamsPluginWeb | ChatGenerationParamsPluginFileParser | ChatGenerationParamsPluginResponseHealing | ChatGenerationParamsPluginContextCompression;
|
|
231
|
+
/**
|
|
232
|
+
* 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.
|
|
233
|
+
*/
|
|
234
|
+
export type ChatGenerationParamsTrace = {
|
|
235
|
+
traceId?: string | undefined;
|
|
236
|
+
traceName?: string | undefined;
|
|
237
|
+
spanName?: string | undefined;
|
|
238
|
+
generationName?: string | undefined;
|
|
239
|
+
parentSpanId?: string | undefined;
|
|
240
|
+
additionalProperties?: {
|
|
241
|
+
[k: string]: any | null;
|
|
242
|
+
} | undefined;
|
|
243
|
+
};
|
|
244
|
+
/**
|
|
245
|
+
* Constrains effort on reasoning for reasoning models
|
|
246
|
+
*/
|
|
57
247
|
export declare const Effort: {
|
|
58
248
|
readonly Xhigh: "xhigh";
|
|
59
249
|
readonly High: "high";
|
|
@@ -62,170 +252,374 @@ export declare const Effort: {
|
|
|
62
252
|
readonly Minimal: "minimal";
|
|
63
253
|
readonly None: "none";
|
|
64
254
|
};
|
|
255
|
+
/**
|
|
256
|
+
* Constrains effort on reasoning for reasoning models
|
|
257
|
+
*/
|
|
65
258
|
export type Effort = OpenEnum<typeof Effort>;
|
|
259
|
+
/**
|
|
260
|
+
* Configuration options for reasoning models
|
|
261
|
+
*/
|
|
66
262
|
export type Reasoning = {
|
|
263
|
+
/**
|
|
264
|
+
* Constrains effort on reasoning for reasoning models
|
|
265
|
+
*/
|
|
67
266
|
effort?: Effort | null | undefined;
|
|
68
|
-
summary?:
|
|
69
|
-
};
|
|
70
|
-
export type ResponseFormatPython = {
|
|
71
|
-
type: "python";
|
|
267
|
+
summary?: any | null | undefined;
|
|
72
268
|
};
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
export type
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
export type Stop = string | Array<string
|
|
81
|
-
export type
|
|
82
|
-
echoUpstreamBody?: boolean | undefined;
|
|
83
|
-
};
|
|
84
|
-
export type ChatGenerationParamsImageConfig = string | number | Array<any>;
|
|
269
|
+
/**
|
|
270
|
+
* Response format configuration
|
|
271
|
+
*/
|
|
272
|
+
export type ResponseFormat = ResponseFormatText | ResponseFormatJSONObject | ResponseFormatJSONSchema | ResponseFormatTextGrammar | ResponseFormatTextPython;
|
|
273
|
+
/**
|
|
274
|
+
* Stop sequences (up to 4)
|
|
275
|
+
*/
|
|
276
|
+
export type Stop = string | Array<string> | any;
|
|
277
|
+
export type ChatGenerationParamsImageConfig = string | number | Array<any | null>;
|
|
85
278
|
export declare const Modality: {
|
|
86
279
|
readonly Text: "text";
|
|
87
280
|
readonly Image: "image";
|
|
281
|
+
readonly Audio: "audio";
|
|
88
282
|
};
|
|
89
283
|
export type Modality = OpenEnum<typeof Modality>;
|
|
284
|
+
export declare const ChatGenerationParamsType: {
|
|
285
|
+
readonly Ephemeral: "ephemeral";
|
|
286
|
+
};
|
|
287
|
+
export type ChatGenerationParamsType = ClosedEnum<typeof ChatGenerationParamsType>;
|
|
288
|
+
export declare const ChatGenerationParamsTtl: {
|
|
289
|
+
readonly Fivem: "5m";
|
|
290
|
+
readonly Oneh: "1h";
|
|
291
|
+
};
|
|
292
|
+
export type ChatGenerationParamsTtl = OpenEnum<typeof ChatGenerationParamsTtl>;
|
|
293
|
+
/**
|
|
294
|
+
* 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.
|
|
295
|
+
*/
|
|
296
|
+
export type CacheControl = {
|
|
297
|
+
type: ChatGenerationParamsType;
|
|
298
|
+
ttl?: ChatGenerationParamsTtl | undefined;
|
|
299
|
+
};
|
|
300
|
+
/**
|
|
301
|
+
* Chat completion request parameters
|
|
302
|
+
*/
|
|
90
303
|
export type ChatGenerationParams = {
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
304
|
+
/**
|
|
305
|
+
* When multiple model providers are available, optionally indicate your routing preference.
|
|
306
|
+
*/
|
|
307
|
+
provider?: ChatGenerationParamsProvider | null | undefined;
|
|
308
|
+
/**
|
|
309
|
+
* Plugins you want to enable for this request, including their settings.
|
|
310
|
+
*/
|
|
311
|
+
plugins?: Array<ChatGenerationParamsPluginAutoRouter | ChatGenerationParamsPluginModeration | ChatGenerationParamsPluginWeb | ChatGenerationParamsPluginFileParser | ChatGenerationParamsPluginResponseHealing | ChatGenerationParamsPluginContextCompression> | undefined;
|
|
312
|
+
/**
|
|
313
|
+
* Unique user identifier
|
|
314
|
+
*/
|
|
94
315
|
user?: string | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* 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.
|
|
318
|
+
*/
|
|
95
319
|
sessionId?: string | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* 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.
|
|
322
|
+
*/
|
|
323
|
+
trace?: ChatGenerationParamsTrace | undefined;
|
|
324
|
+
/**
|
|
325
|
+
* List of messages for the conversation
|
|
326
|
+
*/
|
|
96
327
|
messages: Array<Message>;
|
|
328
|
+
/**
|
|
329
|
+
* Model to use for completion
|
|
330
|
+
*/
|
|
97
331
|
model?: string | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* Models to use for completion
|
|
334
|
+
*/
|
|
98
335
|
models?: Array<string> | undefined;
|
|
336
|
+
/**
|
|
337
|
+
* Frequency penalty (-2.0 to 2.0)
|
|
338
|
+
*/
|
|
99
339
|
frequencyPenalty?: number | null | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* Token logit bias adjustments
|
|
342
|
+
*/
|
|
100
343
|
logitBias?: {
|
|
101
344
|
[k: string]: number;
|
|
102
345
|
} | null | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* Return log probabilities
|
|
348
|
+
*/
|
|
103
349
|
logprobs?: boolean | null | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* Number of top log probabilities to return (0-20)
|
|
352
|
+
*/
|
|
104
353
|
topLogprobs?: number | null | undefined;
|
|
354
|
+
/**
|
|
355
|
+
* Maximum tokens in completion
|
|
356
|
+
*/
|
|
105
357
|
maxCompletionTokens?: number | null | undefined;
|
|
358
|
+
/**
|
|
359
|
+
* Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16.
|
|
360
|
+
*/
|
|
106
361
|
maxTokens?: number | null | undefined;
|
|
362
|
+
/**
|
|
363
|
+
* Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values)
|
|
364
|
+
*/
|
|
107
365
|
metadata?: {
|
|
108
366
|
[k: string]: string;
|
|
109
367
|
} | undefined;
|
|
368
|
+
/**
|
|
369
|
+
* Presence penalty (-2.0 to 2.0)
|
|
370
|
+
*/
|
|
110
371
|
presencePenalty?: number | null | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* Configuration options for reasoning models
|
|
374
|
+
*/
|
|
111
375
|
reasoning?: Reasoning | undefined;
|
|
112
|
-
|
|
376
|
+
/**
|
|
377
|
+
* Response format configuration
|
|
378
|
+
*/
|
|
379
|
+
responseFormat?: ResponseFormatText | ResponseFormatJSONObject | ResponseFormatJSONSchema | ResponseFormatTextGrammar | ResponseFormatTextPython | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* Random seed for deterministic outputs
|
|
382
|
+
*/
|
|
113
383
|
seed?: number | null | undefined;
|
|
114
|
-
|
|
384
|
+
/**
|
|
385
|
+
* Stop sequences (up to 4)
|
|
386
|
+
*/
|
|
387
|
+
stop?: string | Array<string> | any | null | undefined;
|
|
388
|
+
/**
|
|
389
|
+
* Enable streaming response
|
|
390
|
+
*/
|
|
115
391
|
stream?: boolean | undefined;
|
|
392
|
+
/**
|
|
393
|
+
* Streaming configuration options
|
|
394
|
+
*/
|
|
116
395
|
streamOptions?: ChatStreamOptions | null | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* Sampling temperature (0-2)
|
|
398
|
+
*/
|
|
117
399
|
temperature?: number | null | undefined;
|
|
118
|
-
|
|
400
|
+
parallelToolCalls?: boolean | null | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* Tool choice configuration
|
|
403
|
+
*/
|
|
404
|
+
toolChoice?: ToolChoiceOption | undefined;
|
|
405
|
+
/**
|
|
406
|
+
* Available tools for function calling
|
|
407
|
+
*/
|
|
119
408
|
tools?: Array<ToolDefinitionJson> | undefined;
|
|
409
|
+
/**
|
|
410
|
+
* Nucleus sampling parameter (0-1)
|
|
411
|
+
*/
|
|
120
412
|
topP?: number | null | undefined;
|
|
121
|
-
|
|
413
|
+
/**
|
|
414
|
+
* Debug options for inspecting request transformations (streaming only)
|
|
415
|
+
*/
|
|
416
|
+
debug?: DebugOptions | undefined;
|
|
417
|
+
/**
|
|
418
|
+
* 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.
|
|
419
|
+
*/
|
|
122
420
|
imageConfig?: {
|
|
123
|
-
[k: string]: string | number | Array<any>;
|
|
421
|
+
[k: string]: string | number | Array<any | null>;
|
|
124
422
|
} | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* Output modalities for the response. Supported values are "text", "image", and "audio".
|
|
425
|
+
*/
|
|
125
426
|
modalities?: Array<Modality> | undefined;
|
|
427
|
+
/**
|
|
428
|
+
* 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.
|
|
429
|
+
*/
|
|
430
|
+
cacheControl?: CacheControl | undefined;
|
|
126
431
|
};
|
|
127
432
|
/** @internal */
|
|
128
|
-
export
|
|
433
|
+
export type ChatGenerationParamsOrder$Outbound = string | string;
|
|
434
|
+
/** @internal */
|
|
435
|
+
export declare const ChatGenerationParamsOrder$outboundSchema: z.ZodType<ChatGenerationParamsOrder$Outbound, ChatGenerationParamsOrder>;
|
|
436
|
+
export declare function chatGenerationParamsOrderToJSON(chatGenerationParamsOrder: ChatGenerationParamsOrder): string;
|
|
437
|
+
/** @internal */
|
|
438
|
+
export type ChatGenerationParamsOnly$Outbound = string | string;
|
|
439
|
+
/** @internal */
|
|
440
|
+
export declare const ChatGenerationParamsOnly$outboundSchema: z.ZodType<ChatGenerationParamsOnly$Outbound, ChatGenerationParamsOnly>;
|
|
441
|
+
export declare function chatGenerationParamsOnlyToJSON(chatGenerationParamsOnly: ChatGenerationParamsOnly): string;
|
|
129
442
|
/** @internal */
|
|
130
|
-
export
|
|
443
|
+
export type ChatGenerationParamsIgnore$Outbound = string | string;
|
|
131
444
|
/** @internal */
|
|
132
|
-
export
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
445
|
+
export declare const ChatGenerationParamsIgnore$outboundSchema: z.ZodType<ChatGenerationParamsIgnore$Outbound, ChatGenerationParamsIgnore>;
|
|
446
|
+
export declare function chatGenerationParamsIgnoreToJSON(chatGenerationParamsIgnore: ChatGenerationParamsIgnore): string;
|
|
447
|
+
/** @internal */
|
|
448
|
+
export declare const ChatGenerationParamsSortEnum$outboundSchema: z.ZodType<string, ChatGenerationParamsSortEnum>;
|
|
449
|
+
/** @internal */
|
|
450
|
+
export declare const ChatGenerationParamsProviderSortConfigEnum$outboundSchema: z.ZodEnum<typeof ChatGenerationParamsProviderSortConfigEnum>;
|
|
451
|
+
/** @internal */
|
|
452
|
+
export declare const ChatGenerationParamsBy$outboundSchema: z.ZodType<string, ChatGenerationParamsBy>;
|
|
453
|
+
/** @internal */
|
|
454
|
+
export declare const ChatGenerationParamsPartition$outboundSchema: z.ZodType<string, ChatGenerationParamsPartition>;
|
|
455
|
+
/** @internal */
|
|
456
|
+
export type ChatGenerationParamsProviderSortConfig$Outbound = {
|
|
457
|
+
by?: string | null | undefined;
|
|
458
|
+
partition?: string | null | undefined;
|
|
137
459
|
};
|
|
138
460
|
/** @internal */
|
|
139
|
-
export declare const
|
|
140
|
-
export declare function
|
|
461
|
+
export declare const ChatGenerationParamsProviderSortConfig$outboundSchema: z.ZodType<ChatGenerationParamsProviderSortConfig$Outbound, ChatGenerationParamsProviderSortConfig>;
|
|
462
|
+
export declare function chatGenerationParamsProviderSortConfigToJSON(chatGenerationParamsProviderSortConfig: ChatGenerationParamsProviderSortConfig): string;
|
|
463
|
+
/** @internal */
|
|
464
|
+
export type ChatGenerationParamsProviderSortConfigUnion$Outbound = ChatGenerationParamsProviderSortConfig$Outbound | string;
|
|
465
|
+
/** @internal */
|
|
466
|
+
export declare const ChatGenerationParamsProviderSortConfigUnion$outboundSchema: z.ZodType<ChatGenerationParamsProviderSortConfigUnion$Outbound, ChatGenerationParamsProviderSortConfigUnion>;
|
|
467
|
+
export declare function chatGenerationParamsProviderSortConfigUnionToJSON(chatGenerationParamsProviderSortConfigUnion: ChatGenerationParamsProviderSortConfigUnion): string;
|
|
468
|
+
/** @internal */
|
|
469
|
+
export declare const ChatGenerationParamsProviderSort$outboundSchema: z.ZodType<string, ChatGenerationParamsProviderSort>;
|
|
141
470
|
/** @internal */
|
|
142
|
-
export type
|
|
471
|
+
export type ChatGenerationParamsSortUnion$Outbound = string | ChatGenerationParamsProviderSortConfig$Outbound | string | string;
|
|
143
472
|
/** @internal */
|
|
144
|
-
export declare const
|
|
145
|
-
export declare function
|
|
473
|
+
export declare const ChatGenerationParamsSortUnion$outboundSchema: z.ZodType<ChatGenerationParamsSortUnion$Outbound, ChatGenerationParamsSortUnion>;
|
|
474
|
+
export declare function chatGenerationParamsSortUnionToJSON(chatGenerationParamsSortUnion: ChatGenerationParamsSortUnion): string;
|
|
146
475
|
/** @internal */
|
|
147
|
-
export type
|
|
476
|
+
export type ChatGenerationParamsMaxPrice$Outbound = {
|
|
477
|
+
prompt?: string | undefined;
|
|
478
|
+
completion?: string | undefined;
|
|
479
|
+
image?: string | undefined;
|
|
480
|
+
audio?: string | undefined;
|
|
481
|
+
request?: string | undefined;
|
|
482
|
+
};
|
|
483
|
+
/** @internal */
|
|
484
|
+
export declare const ChatGenerationParamsMaxPrice$outboundSchema: z.ZodType<ChatGenerationParamsMaxPrice$Outbound, ChatGenerationParamsMaxPrice>;
|
|
485
|
+
export declare function chatGenerationParamsMaxPriceToJSON(chatGenerationParamsMaxPrice: ChatGenerationParamsMaxPrice): string;
|
|
486
|
+
/** @internal */
|
|
487
|
+
export type ChatGenerationParamsProvider$Outbound = {
|
|
148
488
|
allow_fallbacks?: boolean | null | undefined;
|
|
149
489
|
require_parameters?: boolean | null | undefined;
|
|
150
490
|
data_collection?: string | null | undefined;
|
|
151
491
|
zdr?: boolean | null | undefined;
|
|
152
492
|
enforce_distillable_text?: boolean | null | undefined;
|
|
153
|
-
order?: Array<
|
|
154
|
-
only?: Array<
|
|
155
|
-
ignore?: Array<
|
|
493
|
+
order?: Array<string | string> | null | undefined;
|
|
494
|
+
only?: Array<string | string> | null | undefined;
|
|
495
|
+
ignore?: Array<string | string> | null | undefined;
|
|
156
496
|
quantizations?: Array<string> | null | undefined;
|
|
157
|
-
sort?:
|
|
158
|
-
max_price?:
|
|
159
|
-
preferred_min_throughput?:
|
|
160
|
-
preferred_max_latency?:
|
|
497
|
+
sort?: string | ChatGenerationParamsProviderSortConfig$Outbound | string | string | null | undefined;
|
|
498
|
+
max_price?: ChatGenerationParamsMaxPrice$Outbound | undefined;
|
|
499
|
+
preferred_min_throughput?: PreferredMinThroughput$Outbound | null | undefined;
|
|
500
|
+
preferred_max_latency?: PreferredMaxLatency$Outbound | null | undefined;
|
|
161
501
|
};
|
|
162
502
|
/** @internal */
|
|
163
|
-
export declare const
|
|
164
|
-
export declare function
|
|
503
|
+
export declare const ChatGenerationParamsProvider$outboundSchema: z.ZodType<ChatGenerationParamsProvider$Outbound, ChatGenerationParamsProvider>;
|
|
504
|
+
export declare function chatGenerationParamsProviderToJSON(chatGenerationParamsProvider: ChatGenerationParamsProvider): string;
|
|
165
505
|
/** @internal */
|
|
166
|
-
export
|
|
506
|
+
export type ChatGenerationParamsPluginContextCompression$Outbound = {
|
|
507
|
+
id: "context-compression";
|
|
508
|
+
enabled?: boolean | undefined;
|
|
509
|
+
engine?: string | undefined;
|
|
510
|
+
};
|
|
167
511
|
/** @internal */
|
|
168
|
-
export declare const
|
|
512
|
+
export declare const ChatGenerationParamsPluginContextCompression$outboundSchema: z.ZodType<ChatGenerationParamsPluginContextCompression$Outbound, ChatGenerationParamsPluginContextCompression>;
|
|
513
|
+
export declare function chatGenerationParamsPluginContextCompressionToJSON(chatGenerationParamsPluginContextCompression: ChatGenerationParamsPluginContextCompression): string;
|
|
169
514
|
/** @internal */
|
|
170
|
-
export type
|
|
171
|
-
|
|
172
|
-
|
|
515
|
+
export type ChatGenerationParamsPluginResponseHealing$Outbound = {
|
|
516
|
+
id: "response-healing";
|
|
517
|
+
enabled?: boolean | undefined;
|
|
173
518
|
};
|
|
174
519
|
/** @internal */
|
|
175
|
-
export declare const
|
|
176
|
-
export declare function
|
|
520
|
+
export declare const ChatGenerationParamsPluginResponseHealing$outboundSchema: z.ZodType<ChatGenerationParamsPluginResponseHealing$Outbound, ChatGenerationParamsPluginResponseHealing>;
|
|
521
|
+
export declare function chatGenerationParamsPluginResponseHealingToJSON(chatGenerationParamsPluginResponseHealing: ChatGenerationParamsPluginResponseHealing): string;
|
|
177
522
|
/** @internal */
|
|
178
|
-
export type
|
|
179
|
-
|
|
523
|
+
export type ChatGenerationParamsPluginFileParser$Outbound = {
|
|
524
|
+
id: "file-parser";
|
|
525
|
+
enabled?: boolean | undefined;
|
|
526
|
+
pdf?: PDFParserOptions$Outbound | undefined;
|
|
180
527
|
};
|
|
181
528
|
/** @internal */
|
|
182
|
-
export declare const
|
|
183
|
-
export declare function
|
|
529
|
+
export declare const ChatGenerationParamsPluginFileParser$outboundSchema: z.ZodType<ChatGenerationParamsPluginFileParser$Outbound, ChatGenerationParamsPluginFileParser>;
|
|
530
|
+
export declare function chatGenerationParamsPluginFileParserToJSON(chatGenerationParamsPluginFileParser: ChatGenerationParamsPluginFileParser): string;
|
|
184
531
|
/** @internal */
|
|
185
|
-
export type
|
|
186
|
-
|
|
532
|
+
export type ChatGenerationParamsPluginWeb$Outbound = {
|
|
533
|
+
id: "web";
|
|
534
|
+
enabled?: boolean | undefined;
|
|
535
|
+
max_results?: number | undefined;
|
|
536
|
+
search_prompt?: string | undefined;
|
|
537
|
+
engine?: string | undefined;
|
|
538
|
+
include_domains?: Array<string> | undefined;
|
|
539
|
+
exclude_domains?: Array<string> | undefined;
|
|
187
540
|
};
|
|
188
541
|
/** @internal */
|
|
189
|
-
export declare const
|
|
190
|
-
export declare function
|
|
542
|
+
export declare const ChatGenerationParamsPluginWeb$outboundSchema: z.ZodType<ChatGenerationParamsPluginWeb$Outbound, ChatGenerationParamsPluginWeb>;
|
|
543
|
+
export declare function chatGenerationParamsPluginWebToJSON(chatGenerationParamsPluginWeb: ChatGenerationParamsPluginWeb): string;
|
|
191
544
|
/** @internal */
|
|
192
|
-
export type
|
|
193
|
-
|
|
545
|
+
export type ChatGenerationParamsPluginModeration$Outbound = {
|
|
546
|
+
id: "moderation";
|
|
194
547
|
};
|
|
195
548
|
/** @internal */
|
|
196
|
-
export declare const
|
|
197
|
-
export declare function
|
|
549
|
+
export declare const ChatGenerationParamsPluginModeration$outboundSchema: z.ZodType<ChatGenerationParamsPluginModeration$Outbound, ChatGenerationParamsPluginModeration>;
|
|
550
|
+
export declare function chatGenerationParamsPluginModerationToJSON(chatGenerationParamsPluginModeration: ChatGenerationParamsPluginModeration): string;
|
|
198
551
|
/** @internal */
|
|
199
|
-
export type
|
|
552
|
+
export type ChatGenerationParamsPluginAutoRouter$Outbound = {
|
|
553
|
+
id: "auto-router";
|
|
554
|
+
enabled?: boolean | undefined;
|
|
555
|
+
allowed_models?: Array<string> | undefined;
|
|
556
|
+
};
|
|
557
|
+
/** @internal */
|
|
558
|
+
export declare const ChatGenerationParamsPluginAutoRouter$outboundSchema: z.ZodType<ChatGenerationParamsPluginAutoRouter$Outbound, ChatGenerationParamsPluginAutoRouter>;
|
|
559
|
+
export declare function chatGenerationParamsPluginAutoRouterToJSON(chatGenerationParamsPluginAutoRouter: ChatGenerationParamsPluginAutoRouter): string;
|
|
560
|
+
/** @internal */
|
|
561
|
+
export type ChatGenerationParamsPluginUnion$Outbound = ChatGenerationParamsPluginAutoRouter$Outbound | ChatGenerationParamsPluginModeration$Outbound | ChatGenerationParamsPluginWeb$Outbound | ChatGenerationParamsPluginFileParser$Outbound | ChatGenerationParamsPluginResponseHealing$Outbound | ChatGenerationParamsPluginContextCompression$Outbound;
|
|
562
|
+
/** @internal */
|
|
563
|
+
export declare const ChatGenerationParamsPluginUnion$outboundSchema: z.ZodType<ChatGenerationParamsPluginUnion$Outbound, ChatGenerationParamsPluginUnion>;
|
|
564
|
+
export declare function chatGenerationParamsPluginUnionToJSON(chatGenerationParamsPluginUnion: ChatGenerationParamsPluginUnion): string;
|
|
565
|
+
/** @internal */
|
|
566
|
+
export type ChatGenerationParamsTrace$Outbound = {
|
|
567
|
+
trace_id?: string | undefined;
|
|
568
|
+
trace_name?: string | undefined;
|
|
569
|
+
span_name?: string | undefined;
|
|
570
|
+
generation_name?: string | undefined;
|
|
571
|
+
parent_span_id?: string | undefined;
|
|
572
|
+
[additionalProperties: string]: unknown;
|
|
573
|
+
};
|
|
574
|
+
/** @internal */
|
|
575
|
+
export declare const ChatGenerationParamsTrace$outboundSchema: z.ZodType<ChatGenerationParamsTrace$Outbound, ChatGenerationParamsTrace>;
|
|
576
|
+
export declare function chatGenerationParamsTraceToJSON(chatGenerationParamsTrace: ChatGenerationParamsTrace): string;
|
|
577
|
+
/** @internal */
|
|
578
|
+
export declare const Effort$outboundSchema: z.ZodType<string, Effort>;
|
|
579
|
+
/** @internal */
|
|
580
|
+
export type Reasoning$Outbound = {
|
|
581
|
+
effort?: string | null | undefined;
|
|
582
|
+
summary?: any | null | undefined;
|
|
583
|
+
};
|
|
584
|
+
/** @internal */
|
|
585
|
+
export declare const Reasoning$outboundSchema: z.ZodType<Reasoning$Outbound, Reasoning>;
|
|
586
|
+
export declare function reasoningToJSON(reasoning: Reasoning): string;
|
|
587
|
+
/** @internal */
|
|
588
|
+
export type ResponseFormat$Outbound = ResponseFormatText$Outbound | ResponseFormatJSONObject$Outbound | ResponseFormatJSONSchema$Outbound | ResponseFormatTextGrammar$Outbound | ResponseFormatTextPython$Outbound;
|
|
200
589
|
/** @internal */
|
|
201
590
|
export declare const ResponseFormat$outboundSchema: z.ZodType<ResponseFormat$Outbound, ResponseFormat>;
|
|
202
591
|
export declare function responseFormatToJSON(responseFormat: ResponseFormat): string;
|
|
203
592
|
/** @internal */
|
|
204
|
-
export type Stop$Outbound = string | Array<string
|
|
593
|
+
export type Stop$Outbound = string | Array<string> | any;
|
|
205
594
|
/** @internal */
|
|
206
595
|
export declare const Stop$outboundSchema: z.ZodType<Stop$Outbound, Stop>;
|
|
207
596
|
export declare function stopToJSON(stop: Stop): string;
|
|
208
597
|
/** @internal */
|
|
209
|
-
export type
|
|
210
|
-
echo_upstream_body?: boolean | undefined;
|
|
211
|
-
};
|
|
212
|
-
/** @internal */
|
|
213
|
-
export declare const Debug$outboundSchema: z.ZodType<Debug$Outbound, Debug>;
|
|
214
|
-
export declare function debugToJSON(debug: Debug): string;
|
|
215
|
-
/** @internal */
|
|
216
|
-
export type ChatGenerationParamsImageConfig$Outbound = string | number | Array<any>;
|
|
598
|
+
export type ChatGenerationParamsImageConfig$Outbound = string | number | Array<any | null>;
|
|
217
599
|
/** @internal */
|
|
218
600
|
export declare const ChatGenerationParamsImageConfig$outboundSchema: z.ZodType<ChatGenerationParamsImageConfig$Outbound, ChatGenerationParamsImageConfig>;
|
|
219
601
|
export declare function chatGenerationParamsImageConfigToJSON(chatGenerationParamsImageConfig: ChatGenerationParamsImageConfig): string;
|
|
220
602
|
/** @internal */
|
|
221
603
|
export declare const Modality$outboundSchema: z.ZodType<string, Modality>;
|
|
222
604
|
/** @internal */
|
|
605
|
+
export declare const ChatGenerationParamsType$outboundSchema: z.ZodEnum<typeof ChatGenerationParamsType>;
|
|
606
|
+
/** @internal */
|
|
607
|
+
export declare const ChatGenerationParamsTtl$outboundSchema: z.ZodType<string, ChatGenerationParamsTtl>;
|
|
608
|
+
/** @internal */
|
|
609
|
+
export type CacheControl$Outbound = {
|
|
610
|
+
type: string;
|
|
611
|
+
ttl?: string | undefined;
|
|
612
|
+
};
|
|
613
|
+
/** @internal */
|
|
614
|
+
export declare const CacheControl$outboundSchema: z.ZodType<CacheControl$Outbound, CacheControl>;
|
|
615
|
+
export declare function cacheControlToJSON(cacheControl: CacheControl): string;
|
|
616
|
+
/** @internal */
|
|
223
617
|
export type ChatGenerationParams$Outbound = {
|
|
224
|
-
provider?:
|
|
225
|
-
plugins?: Array<
|
|
226
|
-
route?: string | null | undefined;
|
|
618
|
+
provider?: ChatGenerationParamsProvider$Outbound | null | undefined;
|
|
619
|
+
plugins?: Array<ChatGenerationParamsPluginAutoRouter$Outbound | ChatGenerationParamsPluginModeration$Outbound | ChatGenerationParamsPluginWeb$Outbound | ChatGenerationParamsPluginFileParser$Outbound | ChatGenerationParamsPluginResponseHealing$Outbound | ChatGenerationParamsPluginContextCompression$Outbound> | undefined;
|
|
227
620
|
user?: string | undefined;
|
|
228
621
|
session_id?: string | undefined;
|
|
622
|
+
trace?: ChatGenerationParamsTrace$Outbound | undefined;
|
|
229
623
|
messages: Array<Message$Outbound>;
|
|
230
624
|
model?: string | undefined;
|
|
231
625
|
models?: Array<string> | undefined;
|
|
@@ -242,20 +636,22 @@ export type ChatGenerationParams$Outbound = {
|
|
|
242
636
|
} | undefined;
|
|
243
637
|
presence_penalty?: number | null | undefined;
|
|
244
638
|
reasoning?: Reasoning$Outbound | undefined;
|
|
245
|
-
response_format?: ResponseFormatText$Outbound | ResponseFormatJSONObject$Outbound | ResponseFormatJSONSchema$Outbound | ResponseFormatTextGrammar$Outbound |
|
|
639
|
+
response_format?: ResponseFormatText$Outbound | ResponseFormatJSONObject$Outbound | ResponseFormatJSONSchema$Outbound | ResponseFormatTextGrammar$Outbound | ResponseFormatTextPython$Outbound | undefined;
|
|
246
640
|
seed?: number | null | undefined;
|
|
247
|
-
stop?: string | Array<string> | null | undefined;
|
|
641
|
+
stop?: string | Array<string> | any | null | undefined;
|
|
248
642
|
stream: boolean;
|
|
249
643
|
stream_options?: ChatStreamOptions$Outbound | null | undefined;
|
|
250
|
-
temperature
|
|
251
|
-
|
|
644
|
+
temperature: number | null;
|
|
645
|
+
parallel_tool_calls?: boolean | null | undefined;
|
|
646
|
+
tool_choice?: ToolChoiceOption$Outbound | undefined;
|
|
252
647
|
tools?: Array<ToolDefinitionJson$Outbound> | undefined;
|
|
253
|
-
top_p
|
|
254
|
-
debug?:
|
|
648
|
+
top_p: number | null;
|
|
649
|
+
debug?: DebugOptions$Outbound | undefined;
|
|
255
650
|
image_config?: {
|
|
256
|
-
[k: string]: string | number | Array<any>;
|
|
651
|
+
[k: string]: string | number | Array<any | null>;
|
|
257
652
|
} | undefined;
|
|
258
653
|
modalities?: Array<string> | undefined;
|
|
654
|
+
cache_control?: CacheControl$Outbound | undefined;
|
|
259
655
|
};
|
|
260
656
|
/** @internal */
|
|
261
657
|
export declare const ChatGenerationParams$outboundSchema: z.ZodType<ChatGenerationParams$Outbound, ChatGenerationParams>;
|