@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,10 +1,21 @@
|
|
|
1
1
|
import * as z from "zod/v4";
|
|
2
2
|
import { ClosedEnum, OpenEnum } from "../types/enums.js";
|
|
3
|
+
import { ContextCompressionEngine } from "./contextcompressionengine.js";
|
|
3
4
|
import { DataCollection } from "./datacollection.js";
|
|
5
|
+
import { DatetimeServerTool, DatetimeServerTool$Outbound } from "./datetimeservertool.js";
|
|
4
6
|
import { OpenAIResponsesIncludable } from "./openairesponsesincludable.js";
|
|
5
7
|
import { OpenAIResponsesPrompt, OpenAIResponsesPrompt$Outbound } from "./openairesponsesprompt.js";
|
|
6
8
|
import { OpenAIResponsesToolChoiceUnion, OpenAIResponsesToolChoiceUnion$Outbound } from "./openairesponsestoolchoiceunion.js";
|
|
7
|
-
import {
|
|
9
|
+
import { OpenResponsesApplyPatchTool, OpenResponsesApplyPatchTool$Outbound } from "./openresponsesapplypatchtool.js";
|
|
10
|
+
import { OpenResponsesCodeInterpreterTool, OpenResponsesCodeInterpreterTool$Outbound } from "./openresponsescodeinterpretertool.js";
|
|
11
|
+
import { OpenResponsesComputerTool, OpenResponsesComputerTool$Outbound } from "./openresponsescomputertool.js";
|
|
12
|
+
import { OpenResponsesCustomTool, OpenResponsesCustomTool$Outbound } from "./openresponsescustomtool.js";
|
|
13
|
+
import { OpenResponsesFileSearchTool, OpenResponsesFileSearchTool$Outbound } from "./openresponsesfilesearchtool.js";
|
|
14
|
+
import { OpenResponsesFunctionShellTool, OpenResponsesFunctionShellTool$Outbound } from "./openresponsesfunctionshelltool.js";
|
|
15
|
+
import { OpenResponsesImageGenerationTool, OpenResponsesImageGenerationTool$Outbound } from "./openresponsesimagegenerationtool.js";
|
|
16
|
+
import { OpenResponsesInputUnion, OpenResponsesInputUnion$Outbound } from "./openresponsesinputunion.js";
|
|
17
|
+
import { OpenResponsesLocalShellTool, OpenResponsesLocalShellTool$Outbound } from "./openresponseslocalshelltool.js";
|
|
18
|
+
import { OpenResponsesMcpTool, OpenResponsesMcpTool$Outbound } from "./openresponsesmcptool.js";
|
|
8
19
|
import { OpenResponsesReasoningConfig, OpenResponsesReasoningConfig$Outbound } from "./openresponsesreasoningconfig.js";
|
|
9
20
|
import { OpenResponsesResponseText, OpenResponsesResponseText$Outbound } from "./openresponsesresponsetext.js";
|
|
10
21
|
import { OpenResponsesWebSearch20250826Tool, OpenResponsesWebSearch20250826Tool$Outbound } from "./openresponseswebsearch20250826tool.js";
|
|
@@ -19,6 +30,7 @@ import { ProviderSort } from "./providersort.js";
|
|
|
19
30
|
import { ProviderSortConfig, ProviderSortConfig$Outbound } from "./providersortconfig.js";
|
|
20
31
|
import { Quantization } from "./quantization.js";
|
|
21
32
|
import { ResponsesOutputModality } from "./responsesoutputmodality.js";
|
|
33
|
+
import { ResponsesWebSearchServerTool, ResponsesWebSearchServerTool$Outbound } from "./responseswebsearchservertool.js";
|
|
22
34
|
import { WebSearchEngine } from "./websearchengine.js";
|
|
23
35
|
/**
|
|
24
36
|
* Function tool definition
|
|
@@ -32,7 +44,7 @@ export type OpenResponsesRequestToolFunction = {
|
|
|
32
44
|
[k: string]: any | null;
|
|
33
45
|
} | null;
|
|
34
46
|
};
|
|
35
|
-
export type OpenResponsesRequestToolUnion = OpenResponsesRequestToolFunction | OpenResponsesWebSearchPreviewTool | OpenResponsesWebSearchPreview20250311Tool | OpenResponsesWebSearchTool | OpenResponsesWebSearch20250826Tool;
|
|
47
|
+
export type OpenResponsesRequestToolUnion = OpenResponsesRequestToolFunction | OpenResponsesWebSearchPreviewTool | OpenResponsesWebSearchPreview20250311Tool | OpenResponsesWebSearchTool | OpenResponsesWebSearch20250826Tool | OpenResponsesFileSearchTool | OpenResponsesComputerTool | OpenResponsesCodeInterpreterTool | OpenResponsesMcpTool | OpenResponsesImageGenerationTool | OpenResponsesLocalShellTool | OpenResponsesFunctionShellTool | OpenResponsesApplyPatchTool | OpenResponsesCustomTool | DatetimeServerTool | ResponsesWebSearchServerTool;
|
|
36
48
|
export type OpenResponsesRequestImageConfig = string | number;
|
|
37
49
|
export declare const ServiceTier: {
|
|
38
50
|
readonly Auto: "auto";
|
|
@@ -66,7 +78,7 @@ export type OpenResponsesRequestMaxPrice = {
|
|
|
66
78
|
/**
|
|
67
79
|
* When multiple model providers are available, optionally indicate your routing preference.
|
|
68
80
|
*/
|
|
69
|
-
export type
|
|
81
|
+
export type OpenResponsesRequestProvider = {
|
|
70
82
|
/**
|
|
71
83
|
* Whether to allow backup providers to serve requests
|
|
72
84
|
*
|
|
@@ -129,14 +141,25 @@ export type Provider = {
|
|
|
129
141
|
*/
|
|
130
142
|
preferredMaxLatency?: PreferredMaxLatency | null | undefined;
|
|
131
143
|
};
|
|
132
|
-
export type
|
|
144
|
+
export type OpenResponsesRequestPluginContextCompression = {
|
|
145
|
+
id: "context-compression";
|
|
146
|
+
/**
|
|
147
|
+
* Set to false to disable the context-compression plugin for this request. Defaults to true.
|
|
148
|
+
*/
|
|
149
|
+
enabled?: boolean | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* The compression engine to use. Defaults to "middle-out".
|
|
152
|
+
*/
|
|
153
|
+
engine?: ContextCompressionEngine | undefined;
|
|
154
|
+
};
|
|
155
|
+
export type OpenResponsesRequestPluginResponseHealing = {
|
|
133
156
|
id: "response-healing";
|
|
134
157
|
/**
|
|
135
158
|
* Set to false to disable the response-healing plugin for this request. Defaults to true.
|
|
136
159
|
*/
|
|
137
160
|
enabled?: boolean | undefined;
|
|
138
161
|
};
|
|
139
|
-
export type
|
|
162
|
+
export type OpenResponsesRequestPluginFileParser = {
|
|
140
163
|
id: "file-parser";
|
|
141
164
|
/**
|
|
142
165
|
* Set to false to disable the file-parser plugin for this request. Defaults to true.
|
|
@@ -147,7 +170,7 @@ export type PluginFileParser = {
|
|
|
147
170
|
*/
|
|
148
171
|
pdf?: PDFParserOptions | undefined;
|
|
149
172
|
};
|
|
150
|
-
export type
|
|
173
|
+
export type OpenResponsesRequestPluginWeb = {
|
|
151
174
|
id: "web";
|
|
152
175
|
/**
|
|
153
176
|
* Set to false to disable the web-search plugin for this request. Defaults to true.
|
|
@@ -159,11 +182,19 @@ export type PluginWeb = {
|
|
|
159
182
|
* The search engine to use for web search.
|
|
160
183
|
*/
|
|
161
184
|
engine?: WebSearchEngine | undefined;
|
|
185
|
+
/**
|
|
186
|
+
* A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").
|
|
187
|
+
*/
|
|
188
|
+
includeDomains?: Array<string> | undefined;
|
|
189
|
+
/**
|
|
190
|
+
* A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").
|
|
191
|
+
*/
|
|
192
|
+
excludeDomains?: Array<string> | undefined;
|
|
162
193
|
};
|
|
163
|
-
export type
|
|
194
|
+
export type OpenResponsesRequestPluginModeration = {
|
|
164
195
|
id: "moderation";
|
|
165
196
|
};
|
|
166
|
-
export type
|
|
197
|
+
export type OpenResponsesRequestPluginAutoRouter = {
|
|
167
198
|
id: "auto-router";
|
|
168
199
|
/**
|
|
169
200
|
* Set to false to disable the auto-router plugin for this request. Defaults to true.
|
|
@@ -174,7 +205,20 @@ export type PluginAutoRouter = {
|
|
|
174
205
|
*/
|
|
175
206
|
allowedModels?: Array<string> | undefined;
|
|
176
207
|
};
|
|
177
|
-
export type
|
|
208
|
+
export type OpenResponsesRequestPluginUnion = OpenResponsesRequestPluginAutoRouter | OpenResponsesRequestPluginModeration | OpenResponsesRequestPluginWeb | OpenResponsesRequestPluginFileParser | OpenResponsesRequestPluginResponseHealing | OpenResponsesRequestPluginContextCompression;
|
|
209
|
+
/**
|
|
210
|
+
* 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.
|
|
211
|
+
*/
|
|
212
|
+
export type OpenResponsesRequestTrace = {
|
|
213
|
+
traceId?: string | undefined;
|
|
214
|
+
traceName?: string | undefined;
|
|
215
|
+
spanName?: string | undefined;
|
|
216
|
+
generationName?: string | undefined;
|
|
217
|
+
parentSpanId?: string | undefined;
|
|
218
|
+
additionalProperties?: {
|
|
219
|
+
[k: string]: any | null;
|
|
220
|
+
} | undefined;
|
|
221
|
+
};
|
|
178
222
|
/**
|
|
179
223
|
* Request schema for Responses endpoint
|
|
180
224
|
*/
|
|
@@ -182,7 +226,7 @@ export type OpenResponsesRequest = {
|
|
|
182
226
|
/**
|
|
183
227
|
* Input for a response request - can be a string or array of items
|
|
184
228
|
*/
|
|
185
|
-
input?:
|
|
229
|
+
input?: OpenResponsesInputUnion | undefined;
|
|
186
230
|
instructions?: string | null | undefined;
|
|
187
231
|
/**
|
|
188
232
|
* Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed.
|
|
@@ -190,7 +234,7 @@ export type OpenResponsesRequest = {
|
|
|
190
234
|
metadata?: {
|
|
191
235
|
[k: string]: string;
|
|
192
236
|
} | null | undefined;
|
|
193
|
-
tools?: Array<OpenResponsesRequestToolFunction | OpenResponsesWebSearchPreviewTool | OpenResponsesWebSearchPreview20250311Tool | OpenResponsesWebSearchTool | OpenResponsesWebSearch20250826Tool> | undefined;
|
|
237
|
+
tools?: Array<OpenResponsesRequestToolFunction | OpenResponsesWebSearchPreviewTool | OpenResponsesWebSearchPreview20250311Tool | OpenResponsesWebSearchTool | OpenResponsesWebSearch20250826Tool | OpenResponsesFileSearchTool | OpenResponsesComputerTool | OpenResponsesCodeInterpreterTool | OpenResponsesMcpTool | OpenResponsesImageGenerationTool | OpenResponsesLocalShellTool | OpenResponsesFunctionShellTool | OpenResponsesApplyPatchTool | OpenResponsesCustomTool | DatetimeServerTool | ResponsesWebSearchServerTool> | undefined;
|
|
194
238
|
toolChoice?: OpenAIResponsesToolChoiceUnion | undefined;
|
|
195
239
|
parallelToolCalls?: boolean | null | undefined;
|
|
196
240
|
model?: string | undefined;
|
|
@@ -234,11 +278,11 @@ export type OpenResponsesRequest = {
|
|
|
234
278
|
/**
|
|
235
279
|
* When multiple model providers are available, optionally indicate your routing preference.
|
|
236
280
|
*/
|
|
237
|
-
provider?:
|
|
281
|
+
provider?: OpenResponsesRequestProvider | null | undefined;
|
|
238
282
|
/**
|
|
239
283
|
* Plugins you want to enable for this request, including their settings.
|
|
240
284
|
*/
|
|
241
|
-
plugins?: Array<
|
|
285
|
+
plugins?: Array<OpenResponsesRequestPluginAutoRouter | OpenResponsesRequestPluginModeration | OpenResponsesRequestPluginWeb | OpenResponsesRequestPluginFileParser | OpenResponsesRequestPluginResponseHealing | OpenResponsesRequestPluginContextCompression> | undefined;
|
|
242
286
|
/**
|
|
243
287
|
* A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 128 characters.
|
|
244
288
|
*/
|
|
@@ -247,6 +291,10 @@ export type OpenResponsesRequest = {
|
|
|
247
291
|
* 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.
|
|
248
292
|
*/
|
|
249
293
|
sessionId?: string | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* 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.
|
|
296
|
+
*/
|
|
297
|
+
trace?: OpenResponsesRequestTrace | undefined;
|
|
250
298
|
};
|
|
251
299
|
/** @internal */
|
|
252
300
|
export type OpenResponsesRequestToolFunction$Outbound = {
|
|
@@ -262,7 +310,7 @@ export type OpenResponsesRequestToolFunction$Outbound = {
|
|
|
262
310
|
export declare const OpenResponsesRequestToolFunction$outboundSchema: z.ZodType<OpenResponsesRequestToolFunction$Outbound, OpenResponsesRequestToolFunction>;
|
|
263
311
|
export declare function openResponsesRequestToolFunctionToJSON(openResponsesRequestToolFunction: OpenResponsesRequestToolFunction): string;
|
|
264
312
|
/** @internal */
|
|
265
|
-
export type OpenResponsesRequestToolUnion$Outbound = OpenResponsesRequestToolFunction$Outbound | OpenResponsesWebSearchPreviewTool$Outbound | OpenResponsesWebSearchPreview20250311Tool$Outbound | OpenResponsesWebSearchTool$Outbound | OpenResponsesWebSearch20250826Tool$Outbound;
|
|
313
|
+
export type OpenResponsesRequestToolUnion$Outbound = OpenResponsesRequestToolFunction$Outbound | OpenResponsesWebSearchPreviewTool$Outbound | OpenResponsesWebSearchPreview20250311Tool$Outbound | OpenResponsesWebSearchTool$Outbound | OpenResponsesWebSearch20250826Tool$Outbound | OpenResponsesFileSearchTool$Outbound | OpenResponsesComputerTool$Outbound | OpenResponsesCodeInterpreterTool$Outbound | OpenResponsesMcpTool$Outbound | OpenResponsesImageGenerationTool$Outbound | OpenResponsesLocalShellTool$Outbound | OpenResponsesFunctionShellTool$Outbound | OpenResponsesApplyPatchTool$Outbound | OpenResponsesCustomTool$Outbound | DatetimeServerTool$Outbound | ResponsesWebSearchServerTool$Outbound;
|
|
266
314
|
/** @internal */
|
|
267
315
|
export declare const OpenResponsesRequestToolUnion$outboundSchema: z.ZodType<OpenResponsesRequestToolUnion$Outbound, OpenResponsesRequestToolUnion>;
|
|
268
316
|
export declare function openResponsesRequestToolUnionToJSON(openResponsesRequestToolUnion: OpenResponsesRequestToolUnion): string;
|
|
@@ -307,7 +355,7 @@ export type OpenResponsesRequestMaxPrice$Outbound = {
|
|
|
307
355
|
export declare const OpenResponsesRequestMaxPrice$outboundSchema: z.ZodType<OpenResponsesRequestMaxPrice$Outbound, OpenResponsesRequestMaxPrice>;
|
|
308
356
|
export declare function openResponsesRequestMaxPriceToJSON(openResponsesRequestMaxPrice: OpenResponsesRequestMaxPrice): string;
|
|
309
357
|
/** @internal */
|
|
310
|
-
export type
|
|
358
|
+
export type OpenResponsesRequestProvider$Outbound = {
|
|
311
359
|
allow_fallbacks?: boolean | null | undefined;
|
|
312
360
|
require_parameters?: boolean | null | undefined;
|
|
313
361
|
data_collection?: string | null | undefined;
|
|
@@ -323,65 +371,88 @@ export type Provider$Outbound = {
|
|
|
323
371
|
preferred_max_latency?: PreferredMaxLatency$Outbound | null | undefined;
|
|
324
372
|
};
|
|
325
373
|
/** @internal */
|
|
326
|
-
export declare const
|
|
327
|
-
export declare function
|
|
374
|
+
export declare const OpenResponsesRequestProvider$outboundSchema: z.ZodType<OpenResponsesRequestProvider$Outbound, OpenResponsesRequestProvider>;
|
|
375
|
+
export declare function openResponsesRequestProviderToJSON(openResponsesRequestProvider: OpenResponsesRequestProvider): string;
|
|
376
|
+
/** @internal */
|
|
377
|
+
export type OpenResponsesRequestPluginContextCompression$Outbound = {
|
|
378
|
+
id: "context-compression";
|
|
379
|
+
enabled?: boolean | undefined;
|
|
380
|
+
engine?: string | undefined;
|
|
381
|
+
};
|
|
382
|
+
/** @internal */
|
|
383
|
+
export declare const OpenResponsesRequestPluginContextCompression$outboundSchema: z.ZodType<OpenResponsesRequestPluginContextCompression$Outbound, OpenResponsesRequestPluginContextCompression>;
|
|
384
|
+
export declare function openResponsesRequestPluginContextCompressionToJSON(openResponsesRequestPluginContextCompression: OpenResponsesRequestPluginContextCompression): string;
|
|
328
385
|
/** @internal */
|
|
329
|
-
export type
|
|
386
|
+
export type OpenResponsesRequestPluginResponseHealing$Outbound = {
|
|
330
387
|
id: "response-healing";
|
|
331
388
|
enabled?: boolean | undefined;
|
|
332
389
|
};
|
|
333
390
|
/** @internal */
|
|
334
|
-
export declare const
|
|
335
|
-
export declare function
|
|
391
|
+
export declare const OpenResponsesRequestPluginResponseHealing$outboundSchema: z.ZodType<OpenResponsesRequestPluginResponseHealing$Outbound, OpenResponsesRequestPluginResponseHealing>;
|
|
392
|
+
export declare function openResponsesRequestPluginResponseHealingToJSON(openResponsesRequestPluginResponseHealing: OpenResponsesRequestPluginResponseHealing): string;
|
|
336
393
|
/** @internal */
|
|
337
|
-
export type
|
|
394
|
+
export type OpenResponsesRequestPluginFileParser$Outbound = {
|
|
338
395
|
id: "file-parser";
|
|
339
396
|
enabled?: boolean | undefined;
|
|
340
397
|
pdf?: PDFParserOptions$Outbound | undefined;
|
|
341
398
|
};
|
|
342
399
|
/** @internal */
|
|
343
|
-
export declare const
|
|
344
|
-
export declare function
|
|
400
|
+
export declare const OpenResponsesRequestPluginFileParser$outboundSchema: z.ZodType<OpenResponsesRequestPluginFileParser$Outbound, OpenResponsesRequestPluginFileParser>;
|
|
401
|
+
export declare function openResponsesRequestPluginFileParserToJSON(openResponsesRequestPluginFileParser: OpenResponsesRequestPluginFileParser): string;
|
|
345
402
|
/** @internal */
|
|
346
|
-
export type
|
|
403
|
+
export type OpenResponsesRequestPluginWeb$Outbound = {
|
|
347
404
|
id: "web";
|
|
348
405
|
enabled?: boolean | undefined;
|
|
349
406
|
max_results?: number | undefined;
|
|
350
407
|
search_prompt?: string | undefined;
|
|
351
408
|
engine?: string | undefined;
|
|
409
|
+
include_domains?: Array<string> | undefined;
|
|
410
|
+
exclude_domains?: Array<string> | undefined;
|
|
352
411
|
};
|
|
353
412
|
/** @internal */
|
|
354
|
-
export declare const
|
|
355
|
-
export declare function
|
|
413
|
+
export declare const OpenResponsesRequestPluginWeb$outboundSchema: z.ZodType<OpenResponsesRequestPluginWeb$Outbound, OpenResponsesRequestPluginWeb>;
|
|
414
|
+
export declare function openResponsesRequestPluginWebToJSON(openResponsesRequestPluginWeb: OpenResponsesRequestPluginWeb): string;
|
|
356
415
|
/** @internal */
|
|
357
|
-
export type
|
|
416
|
+
export type OpenResponsesRequestPluginModeration$Outbound = {
|
|
358
417
|
id: "moderation";
|
|
359
418
|
};
|
|
360
419
|
/** @internal */
|
|
361
|
-
export declare const
|
|
362
|
-
export declare function
|
|
420
|
+
export declare const OpenResponsesRequestPluginModeration$outboundSchema: z.ZodType<OpenResponsesRequestPluginModeration$Outbound, OpenResponsesRequestPluginModeration>;
|
|
421
|
+
export declare function openResponsesRequestPluginModerationToJSON(openResponsesRequestPluginModeration: OpenResponsesRequestPluginModeration): string;
|
|
363
422
|
/** @internal */
|
|
364
|
-
export type
|
|
423
|
+
export type OpenResponsesRequestPluginAutoRouter$Outbound = {
|
|
365
424
|
id: "auto-router";
|
|
366
425
|
enabled?: boolean | undefined;
|
|
367
426
|
allowed_models?: Array<string> | undefined;
|
|
368
427
|
};
|
|
369
428
|
/** @internal */
|
|
370
|
-
export declare const
|
|
371
|
-
export declare function
|
|
429
|
+
export declare const OpenResponsesRequestPluginAutoRouter$outboundSchema: z.ZodType<OpenResponsesRequestPluginAutoRouter$Outbound, OpenResponsesRequestPluginAutoRouter>;
|
|
430
|
+
export declare function openResponsesRequestPluginAutoRouterToJSON(openResponsesRequestPluginAutoRouter: OpenResponsesRequestPluginAutoRouter): string;
|
|
372
431
|
/** @internal */
|
|
373
|
-
export type
|
|
432
|
+
export type OpenResponsesRequestPluginUnion$Outbound = OpenResponsesRequestPluginAutoRouter$Outbound | OpenResponsesRequestPluginModeration$Outbound | OpenResponsesRequestPluginWeb$Outbound | OpenResponsesRequestPluginFileParser$Outbound | OpenResponsesRequestPluginResponseHealing$Outbound | OpenResponsesRequestPluginContextCompression$Outbound;
|
|
433
|
+
/** @internal */
|
|
434
|
+
export declare const OpenResponsesRequestPluginUnion$outboundSchema: z.ZodType<OpenResponsesRequestPluginUnion$Outbound, OpenResponsesRequestPluginUnion>;
|
|
435
|
+
export declare function openResponsesRequestPluginUnionToJSON(openResponsesRequestPluginUnion: OpenResponsesRequestPluginUnion): string;
|
|
436
|
+
/** @internal */
|
|
437
|
+
export type OpenResponsesRequestTrace$Outbound = {
|
|
438
|
+
trace_id?: string | undefined;
|
|
439
|
+
trace_name?: string | undefined;
|
|
440
|
+
span_name?: string | undefined;
|
|
441
|
+
generation_name?: string | undefined;
|
|
442
|
+
parent_span_id?: string | undefined;
|
|
443
|
+
[additionalProperties: string]: unknown;
|
|
444
|
+
};
|
|
374
445
|
/** @internal */
|
|
375
|
-
export declare const
|
|
376
|
-
export declare function
|
|
446
|
+
export declare const OpenResponsesRequestTrace$outboundSchema: z.ZodType<OpenResponsesRequestTrace$Outbound, OpenResponsesRequestTrace>;
|
|
447
|
+
export declare function openResponsesRequestTraceToJSON(openResponsesRequestTrace: OpenResponsesRequestTrace): string;
|
|
377
448
|
/** @internal */
|
|
378
449
|
export type OpenResponsesRequest$Outbound = {
|
|
379
|
-
input?:
|
|
450
|
+
input?: OpenResponsesInputUnion$Outbound | undefined;
|
|
380
451
|
instructions?: string | null | undefined;
|
|
381
452
|
metadata?: {
|
|
382
453
|
[k: string]: string;
|
|
383
454
|
} | null | undefined;
|
|
384
|
-
tools?: Array<OpenResponsesRequestToolFunction$Outbound | OpenResponsesWebSearchPreviewTool$Outbound | OpenResponsesWebSearchPreview20250311Tool$Outbound | OpenResponsesWebSearchTool$Outbound | OpenResponsesWebSearch20250826Tool$Outbound> | undefined;
|
|
455
|
+
tools?: Array<OpenResponsesRequestToolFunction$Outbound | OpenResponsesWebSearchPreviewTool$Outbound | OpenResponsesWebSearchPreview20250311Tool$Outbound | OpenResponsesWebSearchTool$Outbound | OpenResponsesWebSearch20250826Tool$Outbound | OpenResponsesFileSearchTool$Outbound | OpenResponsesComputerTool$Outbound | OpenResponsesCodeInterpreterTool$Outbound | OpenResponsesMcpTool$Outbound | OpenResponsesImageGenerationTool$Outbound | OpenResponsesLocalShellTool$Outbound | OpenResponsesFunctionShellTool$Outbound | OpenResponsesApplyPatchTool$Outbound | OpenResponsesCustomTool$Outbound | DatetimeServerTool$Outbound | ResponsesWebSearchServerTool$Outbound> | undefined;
|
|
385
456
|
tool_choice?: OpenAIResponsesToolChoiceUnion$Outbound | undefined;
|
|
386
457
|
parallel_tool_calls?: boolean | null | undefined;
|
|
387
458
|
model?: string | undefined;
|
|
@@ -410,10 +481,11 @@ export type OpenResponsesRequest$Outbound = {
|
|
|
410
481
|
service_tier: string;
|
|
411
482
|
truncation?: string | null | undefined;
|
|
412
483
|
stream: boolean;
|
|
413
|
-
provider?:
|
|
414
|
-
plugins?: Array<
|
|
484
|
+
provider?: OpenResponsesRequestProvider$Outbound | null | undefined;
|
|
485
|
+
plugins?: Array<OpenResponsesRequestPluginAutoRouter$Outbound | OpenResponsesRequestPluginModeration$Outbound | OpenResponsesRequestPluginWeb$Outbound | OpenResponsesRequestPluginFileParser$Outbound | OpenResponsesRequestPluginResponseHealing$Outbound | OpenResponsesRequestPluginContextCompression$Outbound> | undefined;
|
|
415
486
|
user?: string | undefined;
|
|
416
487
|
session_id?: string | undefined;
|
|
488
|
+
trace?: OpenResponsesRequestTrace$Outbound | undefined;
|
|
417
489
|
};
|
|
418
490
|
/** @internal */
|
|
419
491
|
export declare const OpenResponsesRequest$outboundSchema: z.ZodType<OpenResponsesRequest$Outbound, OpenResponsesRequest>;
|
|
@@ -5,11 +5,22 @@
|
|
|
5
5
|
import * as z from "zod/v4";
|
|
6
6
|
import { remap as remap$ } from "../lib/primitives.js";
|
|
7
7
|
import * as openEnums from "../types/enums.js";
|
|
8
|
+
import { ContextCompressionEngine$outboundSchema, } from "./contextcompressionengine.js";
|
|
8
9
|
import { DataCollection$outboundSchema, } from "./datacollection.js";
|
|
10
|
+
import { DatetimeServerTool$outboundSchema, } from "./datetimeservertool.js";
|
|
9
11
|
import { OpenAIResponsesIncludable$outboundSchema, } from "./openairesponsesincludable.js";
|
|
10
12
|
import { OpenAIResponsesPrompt$outboundSchema, } from "./openairesponsesprompt.js";
|
|
11
13
|
import { OpenAIResponsesToolChoiceUnion$outboundSchema, } from "./openairesponsestoolchoiceunion.js";
|
|
12
|
-
import {
|
|
14
|
+
import { OpenResponsesApplyPatchTool$outboundSchema, } from "./openresponsesapplypatchtool.js";
|
|
15
|
+
import { OpenResponsesCodeInterpreterTool$outboundSchema, } from "./openresponsescodeinterpretertool.js";
|
|
16
|
+
import { OpenResponsesComputerTool$outboundSchema, } from "./openresponsescomputertool.js";
|
|
17
|
+
import { OpenResponsesCustomTool$outboundSchema, } from "./openresponsescustomtool.js";
|
|
18
|
+
import { OpenResponsesFileSearchTool$outboundSchema, } from "./openresponsesfilesearchtool.js";
|
|
19
|
+
import { OpenResponsesFunctionShellTool$outboundSchema, } from "./openresponsesfunctionshelltool.js";
|
|
20
|
+
import { OpenResponsesImageGenerationTool$outboundSchema, } from "./openresponsesimagegenerationtool.js";
|
|
21
|
+
import { OpenResponsesInputUnion$outboundSchema, } from "./openresponsesinputunion.js";
|
|
22
|
+
import { OpenResponsesLocalShellTool$outboundSchema, } from "./openresponseslocalshelltool.js";
|
|
23
|
+
import { OpenResponsesMcpTool$outboundSchema, } from "./openresponsesmcptool.js";
|
|
13
24
|
import { OpenResponsesReasoningConfig$outboundSchema, } from "./openresponsesreasoningconfig.js";
|
|
14
25
|
import { OpenResponsesResponseText$outboundSchema, } from "./openresponsesresponsetext.js";
|
|
15
26
|
import { OpenResponsesWebSearch20250826Tool$outboundSchema, } from "./openresponseswebsearch20250826tool.js";
|
|
@@ -24,6 +35,7 @@ import { ProviderSort$outboundSchema } from "./providersort.js";
|
|
|
24
35
|
import { ProviderSortConfig$outboundSchema, } from "./providersortconfig.js";
|
|
25
36
|
import { Quantization$outboundSchema } from "./quantization.js";
|
|
26
37
|
import { ResponsesOutputModality$outboundSchema, } from "./responsesoutputmodality.js";
|
|
38
|
+
import { ResponsesWebSearchServerTool$outboundSchema, } from "./responseswebsearchservertool.js";
|
|
27
39
|
import { WebSearchEngine$outboundSchema, } from "./websearchengine.js";
|
|
28
40
|
export const ServiceTier = {
|
|
29
41
|
Auto: "auto",
|
|
@@ -50,6 +62,17 @@ export const OpenResponsesRequestToolUnion$outboundSchema = z.union([
|
|
|
50
62
|
OpenResponsesWebSearchPreview20250311Tool$outboundSchema,
|
|
51
63
|
OpenResponsesWebSearchTool$outboundSchema,
|
|
52
64
|
OpenResponsesWebSearch20250826Tool$outboundSchema,
|
|
65
|
+
OpenResponsesFileSearchTool$outboundSchema,
|
|
66
|
+
OpenResponsesComputerTool$outboundSchema,
|
|
67
|
+
OpenResponsesCodeInterpreterTool$outboundSchema,
|
|
68
|
+
OpenResponsesMcpTool$outboundSchema,
|
|
69
|
+
OpenResponsesImageGenerationTool$outboundSchema,
|
|
70
|
+
OpenResponsesLocalShellTool$outboundSchema,
|
|
71
|
+
OpenResponsesFunctionShellTool$outboundSchema,
|
|
72
|
+
OpenResponsesApplyPatchTool$outboundSchema,
|
|
73
|
+
OpenResponsesCustomTool$outboundSchema,
|
|
74
|
+
DatetimeServerTool$outboundSchema,
|
|
75
|
+
ResponsesWebSearchServerTool$outboundSchema,
|
|
53
76
|
]);
|
|
54
77
|
export function openResponsesRequestToolUnionToJSON(openResponsesRequestToolUnion) {
|
|
55
78
|
return JSON.stringify(OpenResponsesRequestToolUnion$outboundSchema.parse(openResponsesRequestToolUnion));
|
|
@@ -99,15 +122,16 @@ export function openResponsesRequestMaxPriceToJSON(openResponsesRequestMaxPrice)
|
|
|
99
122
|
return JSON.stringify(OpenResponsesRequestMaxPrice$outboundSchema.parse(openResponsesRequestMaxPrice));
|
|
100
123
|
}
|
|
101
124
|
/** @internal */
|
|
102
|
-
export const
|
|
103
|
-
.object({
|
|
125
|
+
export const OpenResponsesRequestProvider$outboundSchema = z.object({
|
|
104
126
|
allowFallbacks: z.nullable(z.boolean()).optional(),
|
|
105
127
|
requireParameters: z.nullable(z.boolean()).optional(),
|
|
106
128
|
dataCollection: z.nullable(DataCollection$outboundSchema).optional(),
|
|
107
129
|
zdr: z.nullable(z.boolean()).optional(),
|
|
108
130
|
enforceDistillableText: z.nullable(z.boolean()).optional(),
|
|
109
|
-
order: z.nullable(z.array(z.union([ProviderName$outboundSchema, z.string()])))
|
|
110
|
-
|
|
131
|
+
order: z.nullable(z.array(z.union([ProviderName$outboundSchema, z.string()])))
|
|
132
|
+
.optional(),
|
|
133
|
+
only: z.nullable(z.array(z.union([ProviderName$outboundSchema, z.string()])))
|
|
134
|
+
.optional(),
|
|
111
135
|
ignore: z.nullable(z.array(z.union([ProviderName$outboundSchema, z.string()]))).optional(),
|
|
112
136
|
quantizations: z.nullable(z.array(Quantization$outboundSchema)).optional(),
|
|
113
137
|
sort: z.nullable(z.union([
|
|
@@ -132,51 +156,64 @@ export const Provider$outboundSchema = z
|
|
|
132
156
|
preferredMaxLatency: "preferred_max_latency",
|
|
133
157
|
});
|
|
134
158
|
});
|
|
135
|
-
export function
|
|
136
|
-
return JSON.stringify(
|
|
159
|
+
export function openResponsesRequestProviderToJSON(openResponsesRequestProvider) {
|
|
160
|
+
return JSON.stringify(OpenResponsesRequestProvider$outboundSchema.parse(openResponsesRequestProvider));
|
|
161
|
+
}
|
|
162
|
+
/** @internal */
|
|
163
|
+
export const OpenResponsesRequestPluginContextCompression$outboundSchema = z.object({
|
|
164
|
+
id: z.literal("context-compression"),
|
|
165
|
+
enabled: z.boolean().optional(),
|
|
166
|
+
engine: ContextCompressionEngine$outboundSchema.optional(),
|
|
167
|
+
});
|
|
168
|
+
export function openResponsesRequestPluginContextCompressionToJSON(openResponsesRequestPluginContextCompression) {
|
|
169
|
+
return JSON.stringify(OpenResponsesRequestPluginContextCompression$outboundSchema.parse(openResponsesRequestPluginContextCompression));
|
|
137
170
|
}
|
|
138
171
|
/** @internal */
|
|
139
|
-
export const
|
|
172
|
+
export const OpenResponsesRequestPluginResponseHealing$outboundSchema = z.object({
|
|
140
173
|
id: z.literal("response-healing"),
|
|
141
174
|
enabled: z.boolean().optional(),
|
|
142
175
|
});
|
|
143
|
-
export function
|
|
144
|
-
return JSON.stringify(
|
|
176
|
+
export function openResponsesRequestPluginResponseHealingToJSON(openResponsesRequestPluginResponseHealing) {
|
|
177
|
+
return JSON.stringify(OpenResponsesRequestPluginResponseHealing$outboundSchema.parse(openResponsesRequestPluginResponseHealing));
|
|
145
178
|
}
|
|
146
179
|
/** @internal */
|
|
147
|
-
export const
|
|
180
|
+
export const OpenResponsesRequestPluginFileParser$outboundSchema = z.object({
|
|
148
181
|
id: z.literal("file-parser"),
|
|
149
182
|
enabled: z.boolean().optional(),
|
|
150
183
|
pdf: PDFParserOptions$outboundSchema.optional(),
|
|
151
184
|
});
|
|
152
|
-
export function
|
|
153
|
-
return JSON.stringify(
|
|
185
|
+
export function openResponsesRequestPluginFileParserToJSON(openResponsesRequestPluginFileParser) {
|
|
186
|
+
return JSON.stringify(OpenResponsesRequestPluginFileParser$outboundSchema.parse(openResponsesRequestPluginFileParser));
|
|
154
187
|
}
|
|
155
188
|
/** @internal */
|
|
156
|
-
export const
|
|
189
|
+
export const OpenResponsesRequestPluginWeb$outboundSchema = z.object({
|
|
157
190
|
id: z.literal("web"),
|
|
158
191
|
enabled: z.boolean().optional(),
|
|
159
192
|
maxResults: z.number().optional(),
|
|
160
193
|
searchPrompt: z.string().optional(),
|
|
161
194
|
engine: WebSearchEngine$outboundSchema.optional(),
|
|
195
|
+
includeDomains: z.array(z.string()).optional(),
|
|
196
|
+
excludeDomains: z.array(z.string()).optional(),
|
|
162
197
|
}).transform((v) => {
|
|
163
198
|
return remap$(v, {
|
|
164
199
|
maxResults: "max_results",
|
|
165
200
|
searchPrompt: "search_prompt",
|
|
201
|
+
includeDomains: "include_domains",
|
|
202
|
+
excludeDomains: "exclude_domains",
|
|
166
203
|
});
|
|
167
204
|
});
|
|
168
|
-
export function
|
|
169
|
-
return JSON.stringify(
|
|
205
|
+
export function openResponsesRequestPluginWebToJSON(openResponsesRequestPluginWeb) {
|
|
206
|
+
return JSON.stringify(OpenResponsesRequestPluginWeb$outboundSchema.parse(openResponsesRequestPluginWeb));
|
|
170
207
|
}
|
|
171
208
|
/** @internal */
|
|
172
|
-
export const
|
|
209
|
+
export const OpenResponsesRequestPluginModeration$outboundSchema = z.object({
|
|
173
210
|
id: z.literal("moderation"),
|
|
174
211
|
});
|
|
175
|
-
export function
|
|
176
|
-
return JSON.stringify(
|
|
212
|
+
export function openResponsesRequestPluginModerationToJSON(openResponsesRequestPluginModeration) {
|
|
213
|
+
return JSON.stringify(OpenResponsesRequestPluginModeration$outboundSchema.parse(openResponsesRequestPluginModeration));
|
|
177
214
|
}
|
|
178
215
|
/** @internal */
|
|
179
|
-
export const
|
|
216
|
+
export const OpenResponsesRequestPluginAutoRouter$outboundSchema = z.object({
|
|
180
217
|
id: z.literal("auto-router"),
|
|
181
218
|
enabled: z.boolean().optional(),
|
|
182
219
|
allowedModels: z.array(z.string()).optional(),
|
|
@@ -185,24 +222,48 @@ export const PluginAutoRouter$outboundSchema = z.object({
|
|
|
185
222
|
allowedModels: "allowed_models",
|
|
186
223
|
});
|
|
187
224
|
});
|
|
188
|
-
export function
|
|
189
|
-
return JSON.stringify(
|
|
225
|
+
export function openResponsesRequestPluginAutoRouterToJSON(openResponsesRequestPluginAutoRouter) {
|
|
226
|
+
return JSON.stringify(OpenResponsesRequestPluginAutoRouter$outboundSchema.parse(openResponsesRequestPluginAutoRouter));
|
|
190
227
|
}
|
|
191
228
|
/** @internal */
|
|
192
|
-
export const
|
|
193
|
-
.
|
|
194
|
-
z.lazy(() =>
|
|
195
|
-
z.lazy(() =>
|
|
196
|
-
z.lazy(() =>
|
|
197
|
-
z.lazy(() =>
|
|
198
|
-
z.lazy(() =>
|
|
229
|
+
export const OpenResponsesRequestPluginUnion$outboundSchema = z.union([
|
|
230
|
+
z.lazy(() => OpenResponsesRequestPluginAutoRouter$outboundSchema),
|
|
231
|
+
z.lazy(() => OpenResponsesRequestPluginModeration$outboundSchema),
|
|
232
|
+
z.lazy(() => OpenResponsesRequestPluginWeb$outboundSchema),
|
|
233
|
+
z.lazy(() => OpenResponsesRequestPluginFileParser$outboundSchema),
|
|
234
|
+
z.lazy(() => OpenResponsesRequestPluginResponseHealing$outboundSchema),
|
|
235
|
+
z.lazy(() => OpenResponsesRequestPluginContextCompression$outboundSchema),
|
|
199
236
|
]);
|
|
200
|
-
export function
|
|
201
|
-
return JSON.stringify(
|
|
237
|
+
export function openResponsesRequestPluginUnionToJSON(openResponsesRequestPluginUnion) {
|
|
238
|
+
return JSON.stringify(OpenResponsesRequestPluginUnion$outboundSchema.parse(openResponsesRequestPluginUnion));
|
|
239
|
+
}
|
|
240
|
+
/** @internal */
|
|
241
|
+
export const OpenResponsesRequestTrace$outboundSchema = z.object({
|
|
242
|
+
traceId: z.string().optional(),
|
|
243
|
+
traceName: z.string().optional(),
|
|
244
|
+
spanName: z.string().optional(),
|
|
245
|
+
generationName: z.string().optional(),
|
|
246
|
+
parentSpanId: z.string().optional(),
|
|
247
|
+
additionalProperties: z.record(z.string(), z.nullable(z.any())).optional(),
|
|
248
|
+
}).transform((v) => {
|
|
249
|
+
return {
|
|
250
|
+
...v.additionalProperties,
|
|
251
|
+
...remap$(v, {
|
|
252
|
+
traceId: "trace_id",
|
|
253
|
+
traceName: "trace_name",
|
|
254
|
+
spanName: "span_name",
|
|
255
|
+
generationName: "generation_name",
|
|
256
|
+
parentSpanId: "parent_span_id",
|
|
257
|
+
additionalProperties: null,
|
|
258
|
+
}),
|
|
259
|
+
};
|
|
260
|
+
});
|
|
261
|
+
export function openResponsesRequestTraceToJSON(openResponsesRequestTrace) {
|
|
262
|
+
return JSON.stringify(OpenResponsesRequestTrace$outboundSchema.parse(openResponsesRequestTrace));
|
|
202
263
|
}
|
|
203
264
|
/** @internal */
|
|
204
265
|
export const OpenResponsesRequest$outboundSchema = z.object({
|
|
205
|
-
input:
|
|
266
|
+
input: OpenResponsesInputUnion$outboundSchema.optional(),
|
|
206
267
|
instructions: z.nullable(z.string()).optional(),
|
|
207
268
|
metadata: z.nullable(z.record(z.string(), z.string())).optional(),
|
|
208
269
|
tools: z.array(z.union([
|
|
@@ -211,6 +272,17 @@ export const OpenResponsesRequest$outboundSchema = z.object({
|
|
|
211
272
|
OpenResponsesWebSearchPreview20250311Tool$outboundSchema,
|
|
212
273
|
OpenResponsesWebSearchTool$outboundSchema,
|
|
213
274
|
OpenResponsesWebSearch20250826Tool$outboundSchema,
|
|
275
|
+
OpenResponsesFileSearchTool$outboundSchema,
|
|
276
|
+
OpenResponsesComputerTool$outboundSchema,
|
|
277
|
+
OpenResponsesCodeInterpreterTool$outboundSchema,
|
|
278
|
+
OpenResponsesMcpTool$outboundSchema,
|
|
279
|
+
OpenResponsesImageGenerationTool$outboundSchema,
|
|
280
|
+
OpenResponsesLocalShellTool$outboundSchema,
|
|
281
|
+
OpenResponsesFunctionShellTool$outboundSchema,
|
|
282
|
+
OpenResponsesApplyPatchTool$outboundSchema,
|
|
283
|
+
OpenResponsesCustomTool$outboundSchema,
|
|
284
|
+
DatetimeServerTool$outboundSchema,
|
|
285
|
+
ResponsesWebSearchServerTool$outboundSchema,
|
|
214
286
|
])).optional(),
|
|
215
287
|
toolChoice: OpenAIResponsesToolChoiceUnion$outboundSchema.optional(),
|
|
216
288
|
parallelToolCalls: z.nullable(z.boolean()).optional(),
|
|
@@ -240,16 +312,18 @@ export const OpenResponsesRequest$outboundSchema = z.object({
|
|
|
240
312
|
serviceTier: ServiceTier$outboundSchema.default("auto"),
|
|
241
313
|
truncation: z.nullable(Truncation$outboundSchema).optional(),
|
|
242
314
|
stream: z.boolean().default(false),
|
|
243
|
-
provider: z.nullable(z.lazy(() =>
|
|
315
|
+
provider: z.nullable(z.lazy(() => OpenResponsesRequestProvider$outboundSchema)).optional(),
|
|
244
316
|
plugins: z.array(z.union([
|
|
245
|
-
z.lazy(() =>
|
|
246
|
-
z.lazy(() =>
|
|
247
|
-
z.lazy(() =>
|
|
248
|
-
z.lazy(() =>
|
|
249
|
-
z.lazy(() =>
|
|
317
|
+
z.lazy(() => OpenResponsesRequestPluginAutoRouter$outboundSchema),
|
|
318
|
+
z.lazy(() => OpenResponsesRequestPluginModeration$outboundSchema),
|
|
319
|
+
z.lazy(() => OpenResponsesRequestPluginWeb$outboundSchema),
|
|
320
|
+
z.lazy(() => OpenResponsesRequestPluginFileParser$outboundSchema),
|
|
321
|
+
z.lazy(() => OpenResponsesRequestPluginResponseHealing$outboundSchema),
|
|
322
|
+
z.lazy(() => OpenResponsesRequestPluginContextCompression$outboundSchema),
|
|
250
323
|
])).optional(),
|
|
251
324
|
user: z.string().optional(),
|
|
252
325
|
sessionId: z.string().optional(),
|
|
326
|
+
trace: z.lazy(() => OpenResponsesRequestTrace$outboundSchema).optional(),
|
|
253
327
|
}).transform((v) => {
|
|
254
328
|
return remap$(v, {
|
|
255
329
|
toolChoice: "tool_choice",
|