From a708968a096934936edef19bbad28050ca1ecfb5 Mon Sep 17 00:00:00 2001 From: opper-bot Date: Mon, 2 Feb 2026 09:25:30 +0000 Subject: [PATCH] chore: update TypeScript SDK via automated generation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🤖 Automated SDK update to version 3.4.2 - ✅ Speakeasy SDK generation completed - ✅ TypeScript compilation verified - ✅ ESLint validation passed - ✅ Build artifacts generated - ✅ Smoke tests passed Generated on: 2026-02-02 09:25:30 UTC This PR was created automatically by the SDK generation workflow. --- .speakeasy/gen.lock | 586 +++++++++--------- .speakeasy/gen.yaml | 6 +- .speakeasy/workflow.lock | 12 +- docs/models/annotation.md | 4 +- docs/models/annotationurlcitation.md | 2 + docs/models/audio.md | 3 + ...ctionrequest.md => callfunctionrequest.md} | 6 +- ...ionresponse.md => callfunctionresponse.md} | 8 +- docs/models/chatcompletion.md | 2 + .../chatcompletionallowedtoolchoiceparam.md | 4 +- .../models/chatcompletionallowedtoolsparam.md | 2 + .../chatcompletionassistantmessageparam.md | 2 + docs/models/chatcompletionaudio.md | 3 + docs/models/chatcompletionaudioparam.md | 7 +- .../chatcompletioncontentpartimageparam.md | 2 + ...hatcompletioncontentpartinputaudioparam.md | 2 + .../chatcompletioncontentparttextparam.md | 2 + docs/models/chatcompletioncustomtoolparam.md | 4 +- .../chatcompletiondevelopermessageparam.md | 4 + .../chatcompletionfunctioncalloptionparam.md | 2 + .../models/chatcompletionfunctiontoolparam.md | 2 + docs/models/chatcompletionmessage.md | 2 + .../chatcompletionmessagecustomtoolcall.md | 4 +- ...hatcompletionmessagecustomtoolcallparam.md | 4 +- .../chatcompletionmessagefunctiontoolcall.md | 4 +- ...tcompletionmessagefunctiontoolcallparam.md | 4 +- ...hatcompletionnamedtoolchoicecustomparam.md | 4 + .../chatcompletionnamedtoolchoiceparam.md | 4 + docs/models/chatcompletionnonstreaming.md | 77 +-- ...pletionnonstreamingpromptcacheretention.md | 15 + ...atcompletionnonstreamingreasoningeffort.md | 4 +- .../chatcompletionpredictioncontentparam.md | 3 + docs/models/chatcompletionstreaming.md | 77 +-- ...completionstreamingpromptcacheretention.md | 15 + .../chatcompletionstreamingreasoningeffort.md | 2 +- .../chatcompletionstreamoptionsparam.md | 2 + .../chatcompletionsystemmessageparam.md | 4 + docs/models/chatcompletionusermessageparam.md | 3 + docs/models/choice.md | 2 +- docs/models/choicelogprobs.md | 2 + docs/models/completiontokensdetails.md | 2 + docs/models/completionusage.md | 2 + docs/models/customformatgrammar.md | 4 +- docs/models/customformatgrammargrammar.md | 2 + docs/models/customformattext.md | 2 + docs/models/customoutput.md | 2 + docs/models/filet.md | 2 + docs/models/functioncallinput.md | 4 + docs/models/functioncalloutput.md | 4 + docs/models/functionoutput.md | 2 + docs/models/input.md | 1 + docs/models/jsonpayload.md | 6 +- docs/models/jsonschema.md | 2 + ...chatchatcompletioncustomtoolparamcustom.md | 2 + ...pletionmessagecustomtoolcallparamcustom.md | 2 + ...ionmessagefunctiontoolcallparamfunction.md | 2 + docs/models/operations/delta.md | 4 +- .../updatespanspansspanidpatchrequest.md | 4 +- docs/models/prompttokensdetails.md | 2 + docs/models/responseformatjsonobject.md | 7 + docs/models/responseformatjsonschema.md | 13 +- docs/models/responseformattext.md | 2 + docs/models/updatespanrequest.md | 8 +- docs/models/value2.md | 8 +- docs/models/voice.md | 2 +- docs/models/voiceenum.md | 4 +- docs/models/websearchoptions.md | 3 + docs/models/websearchoptionsuserlocation.md | 4 +- ...websearchoptionsuserlocationapproximate.md | 2 + examples/package-lock.json | 4 +- jsr.json | 2 +- package-lock.json | 26 +- package.json | 4 +- src/funcs/call.ts | 20 +- src/funcs/languageModelsRegisterCustom.ts | 2 + src/funcs/languageModelsUpdateCustom.ts | 3 + src/funcs/stream.ts | 9 +- src/lib/config.ts | 6 +- src/lib/sdks.ts | 4 +- src/mcp-server/mcp-server.ts | 2 +- src/mcp-server/server.ts | 2 +- src/mcp-server/tools/call.ts | 2 +- .../tools/languageModelsRegisterCustom.ts | 4 +- .../tools/languageModelsUpdateCustom.ts | 5 +- src/mcp-server/tools/stream.ts | 2 +- src/models/annotation.ts | 6 + src/models/annotationurlcitation.ts | 3 + src/models/audio.ts | 6 + ...ctionrequest.ts => callfunctionrequest.ts} | 117 ++-- ...ionresponse.ts => callfunctionresponse.ts} | 105 ++-- src/models/chatcompletion.ts | 3 + .../chatcompletionallowedtoolchoiceparam.ts | 6 + src/models/chatcompletionallowedtoolsparam.ts | 3 + .../chatcompletionassistantmessageparam.ts | 3 + src/models/chatcompletionaudio.ts | 6 + src/models/chatcompletionaudioparam.ts | 10 + .../chatcompletioncontentpartimageparam.ts | 3 + ...hatcompletioncontentpartinputaudioparam.ts | 3 + .../chatcompletioncontentparttextparam.ts | 3 + src/models/chatcompletioncustomtoolparam.ts | 6 + .../chatcompletiondevelopermessageparam.ts | 7 + .../chatcompletionfunctioncalloptionparam.ts | 3 + src/models/chatcompletionfunctiontoolparam.ts | 3 + src/models/chatcompletionmessage.ts | 3 + .../chatcompletionmessagecustomtoolcall.ts | 6 + ...hatcompletionmessagecustomtoolcallparam.ts | 6 + .../chatcompletionmessagefunctiontoolcall.ts | 6 + ...tcompletionmessagefunctiontoolcallparam.ts | 6 + ...hatcompletionnamedtoolchoicecustomparam.ts | 7 + .../chatcompletionnamedtoolchoiceparam.ts | 7 + src/models/chatcompletionnonstreaming.ts | 38 ++ .../chatcompletionpredictioncontentparam.ts | 6 + src/models/chatcompletionstreaming.ts | 38 ++ .../chatcompletionstreamoptionsparam.ts | 3 + .../chatcompletionsystemmessageparam.ts | 7 + src/models/chatcompletionusermessageparam.ts | 6 + src/models/choice.ts | 3 + src/models/choicelogprobs.ts | 3 + src/models/completiontokensdetails.ts | 3 + src/models/completionusage.ts | 3 + src/models/customformatgrammar.ts | 6 + src/models/customformatgrammargrammar.ts | 3 + src/models/customformattext.ts | 3 + src/models/customoutput.ts | 3 + src/models/file.ts | 3 + src/models/functioncallinput.ts | 7 + src/models/functioncalloutput.ts | 7 + src/models/functionoutput.ts | 3 + src/models/index.ts | 4 +- src/models/jsonschema.ts | 3 + ...chatchatcompletioncustomtoolparamcustom.ts | 3 + ...pletionmessagecustomtoolcallparamcustom.ts | 3 + ...ionmessagefunctiontoolcallparamfunction.ts | 3 + src/models/prompttokensdetails.ts | 3 + src/models/responseformatjsonobject.ts | 10 + src/models/responseformatjsonschema.ts | 11 + src/models/responseformattext.ts | 3 + src/models/websearchoptions.ts | 6 + src/models/websearchoptionsuserlocation.ts | 6 + ...websearchoptionsuserlocationapproximate.ts | 3 + src/sdk/languagemodels.ts | 5 + src/sdk/sdk.ts | 6 +- 142 files changed, 1058 insertions(+), 591 deletions(-) rename docs/models/{appapipublicv2functioncallcallfunctionrequest.md => callfunctionrequest.md} (99%) rename docs/models/{appapipublicv2functioncallcallfunctionresponse.md => callfunctionresponse.md} (98%) create mode 100644 docs/models/chatcompletionnonstreamingpromptcacheretention.md create mode 100644 docs/models/chatcompletionstreamingpromptcacheretention.md rename src/models/{appapipublicv2functioncallcallfunctionrequest.ts => callfunctionrequest.ts} (60%) rename src/models/{appapipublicv2functioncallcallfunctionresponse.ts => callfunctionresponse.ts} (57%) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 9e1ba85..5e4b822 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,22 +1,22 @@ lockVersion: 2.0.0 id: 7fd487cb-2a73-459e-99e5-2c4e6547175f management: - docChecksum: 4ca2e5a38cd1267ee6f3904ffb919fe6 + docChecksum: 65e951049022fac8c9140fde7008940a docVersion: 2.0.0 - speakeasyVersion: 1.680.11 - generationVersion: 2.788.15 - releaseVersion: 3.4.1 - configChecksum: 2505d61983a54516502c3199a3877c7c + speakeasyVersion: 1.700.2 + generationVersion: 2.801.2 + releaseVersion: 3.4.2 + configChecksum: d9ece046c899abf9e6d797106ba295b8 persistentEdits: - generation_id: c243171f-defa-4e30-9fef-03726035f93a - pristine_commit_hash: acd0fa57347a4055ff5a89cf590b5de329234259 - pristine_tree_hash: afc296ed1d811aa5354b5065995ab67b4ba15949 + generation_id: 3497c4aa-71c4-492c-8ea6-f1f2ab9d560e + pristine_commit_hash: da0163ec7061d43c9d9a8e3f898632dbc69d5999 + pristine_tree_hash: 2cf703b73b8a10936667aec7a967c0e701574c97 features: typescript: additionalDependencies: 0.1.0 - additionalProperties: 0.1.2 + additionalProperties: 0.1.3 constsAndDefaults: 0.1.12 - core: 3.26.17 + core: 3.26.23 defaultEnabledRetries: 0.1.0 deprecations: 2.81.1 devContainers: 2.90.1 @@ -76,20 +76,12 @@ trackedFiles: pristine_git_object: 1e607113247f171cb6be61311d2b5fdd1d7aae5c docs/models/annotation.md: id: faab6b24438b - last_write_checksum: sha1:f6067bc0c0fc2b250b442158e69cb3242556d1cb - pristine_git_object: 07491cca1ab4bfca5e617bfb9f96c660ec77310e + last_write_checksum: sha1:b23103866a6d83626f13b39df2d1acd5b04e0c3b + pristine_git_object: 0af955b56c9179b23d42d41148fe8de463aeb3b8 docs/models/annotationurlcitation.md: id: 3a73378fa514 - last_write_checksum: sha1:4f40d5985f539b0ecedcc5c59d1929a5a229830c - pristine_git_object: 30c80ed6f9deb72d25ba1914aa65970a1e8e8750 - docs/models/appapipublicv2functioncallcallfunctionrequest.md: - id: 9cf1fdcedc3a - last_write_checksum: sha1:ff18b7f39d61ab6f8e0983fed58249a369f440ce - pristine_git_object: 01d2aa9691c85c520a676d2b65485be4d79cdbd1 - docs/models/appapipublicv2functioncallcallfunctionresponse.md: - id: 428a6cce6b14 - last_write_checksum: sha1:a51c7a09d03d54f4e4bf299fc1290c01873882d2 - pristine_git_object: 6878c439a8ca7ded8093f1c416005ed1b86dac36 + last_write_checksum: sha1:eb229a13a12d5756b5d13c99e5460bd50f3404dd + pristine_git_object: ac71e3d1abc74b343e4653693e9f0dc44b69492d docs/models/appapipublicv2functionscallfunctionrequest.md: id: e9f082ece3bc last_write_checksum: sha1:abb193368ce7bef80a85a16a6173aa9b5b25966b @@ -100,8 +92,8 @@ trackedFiles: pristine_git_object: 67b1ba857adfe53c2753c822cffe894667c237de docs/models/audio.md: id: 197ec2b1424a - last_write_checksum: sha1:00b68653717a326ce7f94d71265af195b5067474 - pristine_git_object: 465bfaa884959555796762faab0d8a79b1e64282 + last_write_checksum: sha1:24e3e0979535dc8faa3267b7c7687fd526fdfdb5 + pristine_git_object: cd68d576ef1568692381e8471d7d51e821571c64 docs/models/bodyuploadfileknowledgeknowledgebaseiduploadpost.md: id: 6f240addceef last_write_checksum: sha1:60b8cb814e1413143db30bb3f4ec570b045571ed @@ -110,22 +102,30 @@ trackedFiles: id: 89cc22c950cb last_write_checksum: sha1:6917e6b053b1d43dd2392837acd793b3d65a36ea pristine_git_object: 61f52a3a329d9de087d65cff600d713d7c00f11f + docs/models/callfunctionrequest.md: + id: 6e402141eaaf + last_write_checksum: sha1:e2a29261c1baa39a8a8af476e778769097c5d593 + pristine_git_object: 3e14b6af37b47f1639155ffcd7fcbe1a604ce721 + docs/models/callfunctionresponse.md: + id: 7edcead03403 + last_write_checksum: sha1:1365f995386de2ceb0a96a1844c6c7504033d634 + pristine_git_object: 53bc878790a5e3314ee959977e6c44147a2b2bce docs/models/chatcompletion.md: id: 7087ed1b2694 - last_write_checksum: sha1:bb6e9c542aa316ae5a0214b3651c2675025c8300 - pristine_git_object: ffe3c96425fc14559756ce39a9646b7e059ef2fc + last_write_checksum: sha1:a553689261f4c2665d96de6bca73e6fa07e4bb28 + pristine_git_object: ebe54729482eea3a600892edd20a3d504f701e66 docs/models/chatcompletionallowedtoolchoiceparam.md: id: e3fed3e89033 - last_write_checksum: sha1:2afd2d17b64c6a84d63d9f771d8b20c503c0b9a0 - pristine_git_object: 5d911139eff9b1417a52df9c26d21be935a3b29f + last_write_checksum: sha1:1c2154011ba6f713e70b0dc05ea34c1d310df265 + pristine_git_object: fa0507fdbe3916e9b584b6081963790a380a65b6 docs/models/chatcompletionallowedtoolsparam.md: id: 9df48f583aea - last_write_checksum: sha1:b15907a373e4ebbf35d0a888e3cf404274c9a75b - pristine_git_object: e1e8e628e992b1eb54f4a375f2176d08a5702e58 + last_write_checksum: sha1:11b1bef530267de74cc961cb0285494e782db2fd + pristine_git_object: e077949f9afa1bf05f79edf3c933694bcfac45e1 docs/models/chatcompletionassistantmessageparam.md: id: 98527d311b33 - last_write_checksum: sha1:39db0505a978f02b37e04e710a678118a42712bc - pristine_git_object: 45f1715376092c5488ffbcb1311e986b758b0660 + last_write_checksum: sha1:a01835646701ebcb62beec9fee53eef84bdc76ea + pristine_git_object: 91bec88cb38fc3b8f603c26bd8cc8ad75cc06da1 docs/models/chatcompletionassistantmessageparamcontent1.md: id: a9a9724a28b0 last_write_checksum: sha1:cd5d0a552a6819600b3ce68159009f69331f8837 @@ -140,92 +140,92 @@ trackedFiles: pristine_git_object: 712bdabb4f1996c0b61791e4bdbd69c7bde263d4 docs/models/chatcompletionaudio.md: id: 5db9f3e23630 - last_write_checksum: sha1:12757b3264417681c3ea95cd7d1017319006a704 - pristine_git_object: dd83282a080351502bd769602915701cd6221c64 + last_write_checksum: sha1:a0225fec52d38ab3ab2b5dd89f496cffaa15e29d + pristine_git_object: 26cc7c5eb609991af8dbf23b335af3dc717864d1 docs/models/chatcompletionaudioparam.md: id: b86bb9a2ab41 - last_write_checksum: sha1:41a0968439c843b0b403325b8df13bb5c5cf16ba - pristine_git_object: 1162a5ceee2d3ebb80c88df075b85ffe52193d14 + last_write_checksum: sha1:d99db7387f0bebdfe6f21545a1c9fd5131e339bb + pristine_git_object: 6a95ba2bcf9f1a96adac10a897b7cd4f0727b7b8 docs/models/chatcompletionaudioparamformat.md: id: 112ed65cd0ba last_write_checksum: sha1:f7af83fcea963b93079b9474bf275d2f42a76246 pristine_git_object: e5feef365c2b10965c9a605c309e1dfc2288b977 docs/models/chatcompletioncontentpartimageparam.md: id: 69396d282df3 - last_write_checksum: sha1:a729413664105791138466035ae791492571897d - pristine_git_object: 200eb330a8696c841408e0e2ee07b22134c62395 + last_write_checksum: sha1:a567ce7017efa95108a90abab0e645e6e94a007c + pristine_git_object: f6e71b67d9491e9352de6a1e1f946d205f9149a0 docs/models/chatcompletioncontentpartinputaudioparam.md: id: dbf1547a27c9 - last_write_checksum: sha1:99a9c691ad9f5fdf94161d515ba7f151653d817a - pristine_git_object: ef4c72d8d86371f5ee5a2c6f72e182ed4cd61b0d + last_write_checksum: sha1:153ab27b1b0a6227857ff71e85d813ee6100b43b + pristine_git_object: 2ff225acc8499405e0e54c7e1f88a24a2492d397 docs/models/chatcompletioncontentpartrefusalparam.md: id: 9ffb19aaf30b last_write_checksum: sha1:59bc67f2b0965324487948af690ea3b34a5b1355 pristine_git_object: 069a7cab0f60d4a163f63c186c18bc664c45d87b docs/models/chatcompletioncontentparttextparam.md: id: ef2b6560db6d - last_write_checksum: sha1:02967c67627cb259b5a78f3e8474c2f685467454 - pristine_git_object: 28359d7b11786056bebf13dbad6b56a0f2405fb9 + last_write_checksum: sha1:8ebf85d983f613af4281b2e834af94e3ef1fa0ca + pristine_git_object: 98455fa7db10102ef3329160680091e2cbb2a18f docs/models/chatcompletioncustomtoolparam.md: id: 0c02c2d18d4f - last_write_checksum: sha1:c4e8e34806cfb50b9dfbacfb9af9806c94301e04 - pristine_git_object: c3c1fa4d00c1d6194f03f6e3b79458a508083f91 + last_write_checksum: sha1:a0a837740797096d577a39c1f44aef2fdc4b6982 + pristine_git_object: 49d4e0b4d3ec2fb0367a8df9995969afad52884c docs/models/chatcompletiondevelopermessageparam.md: id: 2360c0c7af35 - last_write_checksum: sha1:b93c88d0039e802fa2c763214305e4fbe31a708e - pristine_git_object: 068e2221ad77f4a5a1774081dbd1dc7ca5cd4905 + last_write_checksum: sha1:be5808ba96387cd35f0b9de96d1fd9963de9e556 + pristine_git_object: ca1bb7b154e3c23e10cebfb115f4957d40cf036d docs/models/chatcompletiondevelopermessageparamcontent.md: id: ea72c7b474cf last_write_checksum: sha1:e1ac690f986614df127146bd39537c62e071b2aa pristine_git_object: f57a056c5b26a97f5f519cf4e65e9e8c195909e7 docs/models/chatcompletionfunctioncalloptionparam.md: id: 8b655d293afc - last_write_checksum: sha1:77714372348b224ee3a473747d55ece271b50e05 - pristine_git_object: b49b38a070d1a16968507cc6873f9691cf1b9ead + last_write_checksum: sha1:c4343d94d40ac341cc7ab0220c6ba561bb75909d + pristine_git_object: 48b4c38a3f3571111536b2284a6b39b0de020005 docs/models/chatcompletionfunctionmessageparam.md: id: 9544be788d4f last_write_checksum: sha1:4d47d8c917882c2e771dd72a887604cbd5aa46d7 pristine_git_object: ec7e5aa64f573e484d312ce38f2a2be18b63a7fe docs/models/chatcompletionfunctiontoolparam.md: id: f8029f20961e - last_write_checksum: sha1:afc8b3a55834b4a557af8b50cd97e7a19d83e129 - pristine_git_object: ad9367cf48ab4abf12c03a546580577ee7e478c1 + last_write_checksum: sha1:bf4e960f322128952ad06e2baa8ad5527f65d0c5 + pristine_git_object: 99ebb7011791cbc032aebc0624c1470ac2a6b06c docs/models/chatcompletionmessage.md: id: 980f9e8f8e17 - last_write_checksum: sha1:6c13b00396cd033cea5a2d3cc1996e889b1ea818 - pristine_git_object: 6d214ef0ba34cdb9d6d58c5ac2ccca2db30ae69e + last_write_checksum: sha1:0a1b3ca24349f22932f563439c146aae8bb84245 + pristine_git_object: 79d855d11f52f6c3c7e23225e378136a0b2516d7 docs/models/chatcompletionmessagecustomtoolcall.md: id: ace36cbf55c0 - last_write_checksum: sha1:2b5dc0afadeb2ba9e50c3b206cecba1819f3220d - pristine_git_object: 0e819d2966ca902a25ca024d7157eb3bbb2967e3 + last_write_checksum: sha1:f0bc5625a0bd62da6231c214a06da7e0fe9a223e + pristine_git_object: 4567ad8b6da103f13050f568ecc294643b711c89 docs/models/chatcompletionmessagecustomtoolcallparam.md: id: 195cdbd15b2b - last_write_checksum: sha1:70aa05ce2e0df50924b08ca65ff1dfab557b31dc - pristine_git_object: 32240fc34c0355fbe43cd7034aac00e4802df5d6 + last_write_checksum: sha1:2cd6ca3a0001b5c47fc9b125ed17b8a2f138b374 + pristine_git_object: d7e3faae18b5aaac71724ac57d620f2fb98b8f24 docs/models/chatcompletionmessagefunctiontoolcall.md: id: 84d952e2b078 - last_write_checksum: sha1:fab09ad61ca6ab8b9e28cfa24f474a0f11001cd1 - pristine_git_object: db81f23d3518f19e0d5c87e6aefb25ee8bb262af + last_write_checksum: sha1:79d50179412493ffcd8d2e756851f6cea8e808c8 + pristine_git_object: 8724358deb639c5453dbf9cbcabfb69b7a543f67 docs/models/chatcompletionmessagefunctiontoolcallparam.md: id: df5941860ac6 - last_write_checksum: sha1:ee2ef739051c56afeff00ee6f6c60d5bb466541f - pristine_git_object: 5aa50190f9e8586e682bb94f628eaffff6749fc5 + last_write_checksum: sha1:e78b3494d5556fce811f88f69252a31eb757a1e3 + pristine_git_object: e7b07778497278b16fffc4855e62c49cdffda253 docs/models/chatcompletionmessagetoolcall.md: id: 1f89cd3acd26 last_write_checksum: sha1:67208ed2deeaeffa17195a16e055fb0775d66110 pristine_git_object: c28f3179f096db134a8ec4bb436b233350f57dad docs/models/chatcompletionnamedtoolchoicecustomparam.md: id: 84531c282b97 - last_write_checksum: sha1:6e928bfafd87402a3e97880d04fca4f4bcb83351 - pristine_git_object: c3877acc7b44f58b0990e86fb58c4a32abcc1113 + last_write_checksum: sha1:1c80d837dd3e5b869286e1349e2de5e90b544539 + pristine_git_object: 2c2d8ec56057fe4667c3271bae6f514d8c395c28 docs/models/chatcompletionnamedtoolchoiceparam.md: id: 549a2b573300 - last_write_checksum: sha1:9f5932d83fb5b59746476f1737a3825153f52408 - pristine_git_object: d98357fa039ef976b6a2cd6b009c8b320bce622c + last_write_checksum: sha1:3b60664e4ef6e477f26e269698771e0a65878432 + pristine_git_object: 60c71ee6133e31d62084f67393effa0180359835 docs/models/chatcompletionnonstreaming.md: id: 624dd746fb75 - last_write_checksum: sha1:c1ac084a2f95b02ce98c62358ab6d056ef710eb6 - pristine_git_object: f9909b6fd0576ebb4d3fef8f743c5a389d57ced0 + last_write_checksum: sha1:df6bc08d133957af57d17a2894b1597008bf5f96 + pristine_git_object: db5a338df627a851754a72e9d2eb09165afd308f docs/models/chatcompletionnonstreamingfunctioncallenum.md: id: bbf7f75f7499 last_write_checksum: sha1:0e474645fd98741c94aed0626df669189424a252 @@ -242,10 +242,14 @@ trackedFiles: id: 5a63d9f4a4b6 last_write_checksum: sha1:180739d6fbe0ff4e068042bfc5b4a854fe3a111e pristine_git_object: fca507258a5d733ddb7eda66a8efa85dce0ec15e + docs/models/chatcompletionnonstreamingpromptcacheretention.md: + id: 7e4b3971cdd5 + last_write_checksum: sha1:06637d494f1157548f95e0e6fbeff91f4d625d85 + pristine_git_object: 2682e292efc3b8c9fb0d336dec94666dc6e512a0 docs/models/chatcompletionnonstreamingreasoningeffort.md: id: aecbe7b4f62e - last_write_checksum: sha1:ad62e90bebc30a51ac6477e2ca54d33b136ae511 - pristine_git_object: 96506ba80abc6d5cc46cd0880f59cfea157d62af + last_write_checksum: sha1:881e2b46fe247b2601efaa989eff8261d234bb89 + pristine_git_object: f6ab9cf49dfc4aa55976db928ef0572b07b12ed6 docs/models/chatcompletionnonstreamingresponseformat.md: id: 2a745e49bd9b last_write_checksum: sha1:801621e2f36749a46859d7a6d9fd28054447a48f @@ -276,8 +280,8 @@ trackedFiles: pristine_git_object: f1c50cc34a73619f57664167f07a711cf7878403 docs/models/chatcompletionpredictioncontentparam.md: id: 7f0b8f8ef9d1 - last_write_checksum: sha1:fe1b53931b6f2ba8f57fc096df092754d11944c6 - pristine_git_object: 3ff3198909280f263ae193e71e33cd302b7b79ba + last_write_checksum: sha1:b428154b2c777d1c7d93d470e88417aedfe7b21e + pristine_git_object: f4ec39876e754139db111c5006a0e9d25c1fd2db docs/models/chatcompletionpredictioncontentparamcontent.md: id: 30af0a556b3b last_write_checksum: sha1:b4374bdefe0ca5f7968f437cea6a5ccc7b024696 @@ -288,8 +292,8 @@ trackedFiles: pristine_git_object: 9448b553b6f343bb1793b9b42df09ae979f5fe9c docs/models/chatcompletionstreaming.md: id: ceff166241d9 - last_write_checksum: sha1:26305607feb9b265f4678fc53886acf066cab7c5 - pristine_git_object: 0227faf57da5f61017a4d221d891f66d9f7af0c8 + last_write_checksum: sha1:12a721b8746e27e60bfb1d0331f0008674cc6260 + pristine_git_object: 8878f63d5bf681451a350facb7893df6608bb24f docs/models/chatcompletionstreamingfunctioncallenum.md: id: e39de79e4953 last_write_checksum: sha1:ae16805ea428636bc6e66ebc7cb192106aeb015a @@ -306,10 +310,14 @@ trackedFiles: id: 25a54c2e4907 last_write_checksum: sha1:420f15feae4378d19458b9894e5459272120ea2b pristine_git_object: 774defab741421512df5ef8f9e61651d5316ff13 + docs/models/chatcompletionstreamingpromptcacheretention.md: + id: fedd2efbeb48 + last_write_checksum: sha1:bad9fcddc61ef25b993953c0091e273f3ae9c347 + pristine_git_object: 985f6b0be23f1332d30fbbcbcf40da67cefd4428 docs/models/chatcompletionstreamingreasoningeffort.md: id: 5c0a27f2ce8f - last_write_checksum: sha1:47848ec59be1ada7b387181a2c9048c7ccede5b0 - pristine_git_object: d913d8bc75bb7916b539db763f5c04b976d1208a + last_write_checksum: sha1:140ab6d5fd53a540282fbf70addbe45d3cb3cc2c + pristine_git_object: 21e663aab7a243e2aa6cdacc378435859d6f41b1 docs/models/chatcompletionstreamingresponseformat.md: id: 3a17547cbb6d last_write_checksum: sha1:69abdb4245f8bbe9d40b330d4214479f0e5e318c @@ -340,12 +348,12 @@ trackedFiles: pristine_git_object: bda551b2643935f44876a6201044bb5aaa716e44 docs/models/chatcompletionstreamoptionsparam.md: id: c1d2378c8a7e - last_write_checksum: sha1:f6eaf0e615c27eadae1986fecaf1e7b75cea842a - pristine_git_object: 38ccec431b3d951c81219b9926c6e013b07b7c81 + last_write_checksum: sha1:745cc337568ff50983a92fcb33880ec535993897 + pristine_git_object: ba375a661b4a9f3a2bf0ddee45ae3ba4c7d113ff docs/models/chatcompletionsystemmessageparam.md: id: 814d93e2fd52 - last_write_checksum: sha1:6c2243072a3887ec0d30a5a8e2278891e07fbb0c - pristine_git_object: d0e43a17cf361e61132dfda9eff32d498702dbd5 + last_write_checksum: sha1:d16e97c287ce8ea4e124e2c5fe697ccdf8692096 + pristine_git_object: 05ca2e43b917e65b2640e52c8d1a9fb7dabae33f docs/models/chatcompletionsystemmessageparamcontent.md: id: 6492cc968c4e last_write_checksum: sha1:7045bfe1c255df6348d6b6146820e7de251414f9 @@ -364,8 +372,8 @@ trackedFiles: pristine_git_object: a83217b9f4043382f0616d24046962aa9e427a93 docs/models/chatcompletionusermessageparam.md: id: c3841976f1cd - last_write_checksum: sha1:b9387fa653cb32c35383cf58798c5bc9bea8951b - pristine_git_object: cd77728422e7231c0d280ec8a13b659842028128 + last_write_checksum: sha1:c2325e8a4fc0aa1133794cb7a57de2893583e444 + pristine_git_object: 28f7aaebe2a6de2354e9aa69cde76a90d1169411 docs/models/chatcompletionusermessageparamcontent1.md: id: 9f902bc8a6ed last_write_checksum: sha1:11073d584839f8a14051d72eba6233bac7bfc9c4 @@ -376,20 +384,20 @@ trackedFiles: pristine_git_object: c4fecb8196a26780381df1d2bbba64308edc0051 docs/models/choice.md: id: 7ccf99e7bcf5 - last_write_checksum: sha1:e01523fd33cb80dd3ee013ee01ed0b7912ac9b7a - pristine_git_object: 8c3f0c55f05ac12f8f821a3606da04f3defe3cbe + last_write_checksum: sha1:e2049ea1bc060c5575304eff0574dff0661ad155 + pristine_git_object: 1f6688102b688c509c1feacbfcfd206668881c5a docs/models/choicelogprobs.md: id: e1ec608a588b - last_write_checksum: sha1:25deba25ac1dfd33646040730010a751897401de - pristine_git_object: 311d9d701e0886e135fce7d8d2521c5ea5a84ec2 + last_write_checksum: sha1:327a1529da7477020d38563e950e26b2f125f2c3 + pristine_git_object: ebb611d8e2816fdeb4ced624cf4fbe67a5512489 docs/models/completiontokensdetails.md: id: 72beafa9a4c8 - last_write_checksum: sha1:c98d611efc94301c3f932daad2d2f6255ebbcef0 - pristine_git_object: da95ad701bfd0bd4fb3d3faf26f2fe9bf5c77ee2 + last_write_checksum: sha1:55d66e3e59ea75fdb74c269f5ff90bee656804d8 + pristine_git_object: dc48c65e7a88c97c31bdf48f5dc129efced94eb4 docs/models/completionusage.md: id: 930ebf17acf4 - last_write_checksum: sha1:fc790cd5c2c3745da9ad54deada35b8cd864ee24 - pristine_git_object: 32e14a4ab846c671e3745916e7556724af1b0883 + last_write_checksum: sha1:ecf22d4ab1f292e3c778aa981254cd16f21af174 + pristine_git_object: 1d434571bf3623f85b047ff7e59e781c31e99ffd docs/models/createdatasetentryrequest.md: id: c134b1731b1f last_write_checksum: sha1:1273eb6bb273946c486c956317daddef9e3d00d3 @@ -448,20 +456,20 @@ trackedFiles: pristine_git_object: 2f35a8af0bfd96b8f7c141298a775eb60c4b94c2 docs/models/customformatgrammar.md: id: 30681ed71a99 - last_write_checksum: sha1:cc92425ca869a73e384ef9fd9dd94d271e5ff9ed - pristine_git_object: 16dfeff413c5bd612246cd5a6d201a066308e1bb + last_write_checksum: sha1:17eddef20da5982acab82ba4afcf31bd1b129ea4 + pristine_git_object: 1ca0670cc2cec0bc9bae557a352ec1b5a943d5c1 docs/models/customformatgrammargrammar.md: id: b17337b48814 - last_write_checksum: sha1:f9293e6ed8d9afe1820e99e6e0e6df4edd1e5345 - pristine_git_object: cfe38aaecbde5ff3edb86c27118d8d13186acdca + last_write_checksum: sha1:5cbe99787f9084354bdc65b70d15e3c38fdd6798 + pristine_git_object: 8a1d5fe9ce6eb75bc0800dcb96325d5e77aa10ec docs/models/customformattext.md: id: 98a8bd96a4f8 - last_write_checksum: sha1:6605ccaf1be1d3852cf148aead24fd725d95741c - pristine_git_object: f9b592bde2a88ffc7f8ac2678927a9f2a9108e85 + last_write_checksum: sha1:1f57a67b7f02f3ba5e01b8b957d77af203d6b4ac + pristine_git_object: 31439ae4afb25c15ebe0807f56761f50b0278c88 docs/models/customoutput.md: id: 25722fc766e6 - last_write_checksum: sha1:df170c925b4ecfd5a5be4529aa12b969094f4c85 - pristine_git_object: 461bcbe53391bab15c3c316ff3a2ddc97fd79684 + last_write_checksum: sha1:c00cd84fd8a273500c8d1d8067e9764b2b8e3b29 + pristine_git_object: eaa25b76d7219b9e252311cebc7446b86602bd30 docs/models/deleteknowledgebaserequest.md: id: b5d4f9004c57 last_write_checksum: sha1:cabcb4f9b6d762d75c724e034241b64d770b37bc @@ -524,8 +532,8 @@ trackedFiles: pristine_git_object: 71ac224dd304bcb236eafa9c92fd767e6abff4eb docs/models/filet.md: id: a3e5d1b56bb6 - last_write_checksum: sha1:3d50897d88d33f200c469cb6b00732428504bd28 - pristine_git_object: 4cbe3e44928be759af1cf9e4b73b6c22448568d0 + last_write_checksum: sha1:557bba50385941c5fd953af644c40bc195839270 + pristine_git_object: ae92489fda35adc5d06d2c4728527eb406b31238 docs/models/filter.md: id: b5c476e3dfbc last_write_checksum: sha1:f0ba09f0f4ab4c8e0eaab0e10d5201e409874bcb @@ -548,20 +556,20 @@ trackedFiles: pristine_git_object: dc51c731e16a12cea47e5236c9b82850e695c9a4 docs/models/functioncallinput.md: id: 4691d850186c - last_write_checksum: sha1:9aa729a8a7e00710ffe12b57502154192741dec7 - pristine_git_object: bc0c33f6764fe2ef25eff03130d93c2b554c04d8 + last_write_checksum: sha1:5aa947064bad09d91d8a6444a858be701e3d7f92 + pristine_git_object: 8b3e9f11e12fb4a65bfdfe92e8df626be13751f7 docs/models/functioncalloutput.md: id: 924916e779e8 - last_write_checksum: sha1:2d362039fcdbb0bc54bd6abec305d4469116c7ee - pristine_git_object: 5ca4368fdd93b7401ef3db5cc4a3e263d92faf17 + last_write_checksum: sha1:1387de1097930bfbebd44b4fa88507c865162e4d + pristine_git_object: 3afb3b4e4e40e36e68245d169004b2e102957ca2 docs/models/functiondefinition.md: id: ad3367fb72da last_write_checksum: sha1:52f9e3284180d77b43c246c704047534ba2d180c pristine_git_object: e06b6fa1086389e521382c74e4bee68f328d5206 docs/models/functionoutput.md: id: d9a009ccdb40 - last_write_checksum: sha1:2c4f96b7c910978e90c9c87f299fdf8f5130c87c - pristine_git_object: 4ecdedb4800f5c1392163405f1f55e984186edfd + last_write_checksum: sha1:5c002a11d0442d2810acacec485692fcf3822ce0 + pristine_git_object: 73e133248d65a71116623ab6ca0ee902b970565b docs/models/getcustommodelresponse.md: id: 387b880f5c2a last_write_checksum: sha1:7ea81cfd97718465747d95c410ebf5ea0970bb89 @@ -620,8 +628,8 @@ trackedFiles: pristine_git_object: 1fd4fcf2071ab7c78ef13d1ce8953cf888ed1d8e docs/models/input.md: id: 5cbc446a3956 - last_write_checksum: sha1:5e7b69efdd322a3808f933c06f698d0289269513 - pristine_git_object: c73264481890bf7ad5220296da71cb666195d5d1 + last_write_checksum: sha1:3f36c4796fe8b3b67eaab6b9c9cafa41c5f3e3d6 + pristine_git_object: c5b0cb4c0e55539d8dd9349ba4bf47b46511eec2 docs/models/inputaudio.md: id: cf8d2935b1e7 last_write_checksum: sha1:efaaf4f285b8164a2a3e5e07eda51701af60b1b8 @@ -632,12 +640,12 @@ trackedFiles: pristine_git_object: 8f4be0ec1080259bd5f365b36fbab400d30f48e4 docs/models/jsonpayload.md: id: aee262eb3554 - last_write_checksum: sha1:a0068cc3b68f763ae7eaaf2c34229a8d8d6daaf3 - pristine_git_object: 88bb7e79a21fc65823af0e6d25bfc356c9e22e63 + last_write_checksum: sha1:c8b33df0f0e64ea0d0cdee237d1320ea6f9b5b17 + pristine_git_object: bf534e13d0ca499e0f5d72eef6dc4d8b78809cdc docs/models/jsonschema.md: id: a6b15ed6fac8 - last_write_checksum: sha1:20051409db5a492d3b2468e8254aa691cbcf2fb1 - pristine_git_object: b4a1e57694b8da578afbb30b4767e4eb21e01307 + last_write_checksum: sha1:270cc12a4f436a7d943e8f8eb3c1a8979f9801c1 + pristine_git_object: fd1b60dc774d141564fb0d4594bea7e73b04a165 docs/models/listcustommodelsresponseitem.md: id: 35c270b9763b last_write_checksum: sha1:226faacee420f68c09bcafe6bf92bc8c588a24a4 @@ -736,16 +744,16 @@ trackedFiles: pristine_git_object: edcdf2f3555b02461e52243f7d0abb934434a8f7 docs/models/openaitypeschatchatcompletioncustomtoolparamcustom.md: id: 1de782f78209 - last_write_checksum: sha1:30b11473374baf29f4fe74b5f928e0a77a01479f - pristine_git_object: bb0f89007e361677dfff708ad9994a0912a93c5b + last_write_checksum: sha1:80c3518ec47e7312ba3088b0680f72ab26a5187f + pristine_git_object: 4c0feafaac2187b2f5fb8ca63647daad8745b40c docs/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md: id: 410a88ff8ffb - last_write_checksum: sha1:f52e20f314b55b323a8ad6219793869a35366d3e - pristine_git_object: b8326b43ad391c1357359d4811247e655bd51c86 + last_write_checksum: sha1:9f318073cebec027d16dee2a077b3cbfa0bd47fe + pristine_git_object: 553c61291d0fba2ec56ff256387009c6cce0d804 docs/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.md: id: e4ecba7535af - last_write_checksum: sha1:629b824364bec1bbfd8101d8dddfcc2eda07a982 - pristine_git_object: 0f16b4b9c42ee1362ebd3485eb4d97c47279fa9e + last_write_checksum: sha1:bb34eb6ceb93cf337c10b784cea0e30ab96fdfcf + pristine_git_object: 4756210a729b576a0bbf74b8bff4c1da8f58af85 docs/models/openaitypeschatchatcompletionnamedtoolchoicecustomparamcustom.md: id: a49a4f65e52d last_write_checksum: sha1:e82c0f9536b0c06ce4194e7bc4038cfde28be32a @@ -816,8 +824,8 @@ trackedFiles: pristine_git_object: b7b8ffa8cf18103974a987cae5ea76f281d22ef4 docs/models/operations/delta.md: id: f7eb7cd6d812 - last_write_checksum: sha1:12a41ef89844cf8428555cbbf1eb45de354e7936 - pristine_git_object: c60cf6c3d9a5d8f63c11bccac122a7904a23ec48 + last_write_checksum: sha1:0a17d39e88bac60d3858b2fef4e0ffc6d7f00201 + pristine_git_object: b7352e286aa8cf5bd546ac598d9d5be6cf39bffb docs/models/operations/functionstreamcallstreampostresponse.md: id: 3f8e26f8f20d last_write_checksum: sha1:0a093a2c741a2bcc2970add003ad2167dc490b8c @@ -1012,8 +1020,8 @@ trackedFiles: pristine_git_object: b91b7fbdba7b1d4a82692d7b29f9cd3f9f890170 docs/models/operations/updatespanspansspanidpatchrequest.md: id: 3807d912b962 - last_write_checksum: sha1:3832cb1143b4a8ea9dcb0809b032942d8e720def - pristine_git_object: 0da6d5c0bf13d7af9b4bb7603a9693bc60f33d61 + last_write_checksum: sha1:f7b9dc766006119be5d8b455024b4bff8d1b46d2 + pristine_git_object: 3f5acf1bbb6c249339a250fdec2a3b184ac13771 docs/models/operations/uploadfileknowledgeknowledgebaseiduploadpostrequest.md: id: 660a4bf8bd1e last_write_checksum: sha1:d3db44f9870a08cad951ee61a78ef0c1f9d9f8b5 @@ -1072,8 +1080,8 @@ trackedFiles: pristine_git_object: 916a3ae2d02911ce0d708b461d3032fadb900876 docs/models/prompttokensdetails.md: id: 1391892fce0a - last_write_checksum: sha1:2d6311e0e08a90137512da380b37c5f7be89aa32 - pristine_git_object: cefdd05280457cb17456e73bb99976d1c1a4d18f + last_write_checksum: sha1:a04094a1fea87d74f0278e04a5e0a7f1cb2439c0 + pristine_git_object: 723d0fb8b633ad103af4316a0a044bee3715a237 docs/models/querydatasetentriesresponse.md: id: 05ce0dd5285d last_write_checksum: sha1:fd8c0aa7f67fdb9b6f24a34ed2f7fb35cb583bc0 @@ -1124,16 +1132,16 @@ trackedFiles: pristine_git_object: e2d15675ce4bdc929bdc68e3a6072e8cd586cd42 docs/models/responseformatjsonobject.md: id: 83559bf262cc - last_write_checksum: sha1:3abe8f3dbd0054e2a46280b92cfcc2d5b69ef615 - pristine_git_object: dfc925fe9e422057a56261328651fbd70c402fe4 + last_write_checksum: sha1:cd14a5578273127ef3b3d088133d6ddf1b3e139c + pristine_git_object: eb1624a84698df14bf445a45d825f779a2e6fd55 docs/models/responseformatjsonschema.md: id: 3a7c34c63fa5 - last_write_checksum: sha1:77f15d97af01270d0af0b3cfc88e15a4ebd3f3a6 - pristine_git_object: 3665d7fdb031189a82fa04b5a3c14b1f01346ddf + last_write_checksum: sha1:8652765f3bbd153fc986918d8b7763c974b2ac30 + pristine_git_object: 5499077af5ae65bfe281c5642df4b8d9038630db docs/models/responseformattext.md: id: e80abf091260 - last_write_checksum: sha1:d4ca0b8c390da2e38e1dfb6976754ca696ab5aad - pristine_git_object: 2d35bbb0f64ed43496b1c8b6eb29890f8463ada0 + last_write_checksum: sha1:754a4847782d2044b087519e86a281c79d06bc5d + pristine_git_object: bdcc515606fd0a224d7af28acc2eb787d417ba5b docs/models/savetodatasetresponse.md: id: 2f5ea3c90a84 last_write_checksum: sha1:79ef8bb26d4a0a0b7658973f0072d015434f0aee @@ -1228,8 +1236,8 @@ trackedFiles: pristine_git_object: 475ebf38d243b062fd2522c7848c7c5136d47ec0 docs/models/updatespanrequest.md: id: 0cc273f44164 - last_write_checksum: sha1:b19db8375d6f1b813bd81d5c810fdc29a64cc863 - pristine_git_object: f2a8f24129932c94124888a5c80a493c564823ec + last_write_checksum: sha1:aba80f37fb935c2c4e682310827a1767bd673883 + pristine_git_object: b93fd9b5931ece906b2563759cab581832a4b951 docs/models/updatespanresponse.md: id: 163e62c13f3d last_write_checksum: sha1:0f1aa3c4814eb509f0fa5f0ba8f6cb9e51542a76 @@ -1244,28 +1252,28 @@ trackedFiles: pristine_git_object: f65d35b31b21a815e5f64ef7c7d691616a73ed5e docs/models/value2.md: id: 4eceb26154e6 - last_write_checksum: sha1:a013299bcce3d7ed2a7806abc83ca5d827335b82 - pristine_git_object: 5922b98610d9999f3cabce4c2fe294df3cb76df0 + last_write_checksum: sha1:69ac57c059160b4ccc17a9f73cc84e54ccc0c2f1 + pristine_git_object: 21c866c85a52548aa7d03c95957b00f150817290 docs/models/voice.md: id: f73e25e55a5a - last_write_checksum: sha1:019a12acdca992e3e341f25396cd2ee66d72ac35 - pristine_git_object: c984de7214dea953a60d917d7b2d765e4445df67 + last_write_checksum: sha1:3973d1acb41e3f00be546f91ec368c552bbee3fe + pristine_git_object: 3432a25d23f33690d0ec31df9eacb9a7b96cd023 docs/models/voiceenum.md: id: d02cf0fcfde0 - last_write_checksum: sha1:6a374770186ee33b43f38f74a101d0f259743d69 - pristine_git_object: 4d65af285dbc583cb01e21330411f30cd30ed904 + last_write_checksum: sha1:a91ab6269998584fa66acdc860bc37a306ef6ca0 + pristine_git_object: 94bca1600de08e72f9f466d3c66ef5769e815817 docs/models/websearchoptions.md: id: 0302a3b16daf - last_write_checksum: sha1:a29a5f239347c74b8f45a9919975f7b99ef01b22 - pristine_git_object: a1af0edaa6a7585f1cbeb3acca5858c8011ee21e + last_write_checksum: sha1:96f0b94194757907930afc2d6ccc19de6cc1cb95 + pristine_git_object: 8a2d5e372e22d3c08754e41123570f5136f39571 docs/models/websearchoptionsuserlocation.md: id: 978bc53b300c - last_write_checksum: sha1:fd6e175a530a957093b367a17d24b122cd948c60 - pristine_git_object: 3839aa9e6fda7abd74e8c2fdd60ef0c960b00772 + last_write_checksum: sha1:6ad4eaaa5f4c1a030f6c79b3e6998306c5897841 + pristine_git_object: 5d6c03c42d33bc1e8e5cae2a6a4c246cd570d445 docs/models/websearchoptionsuserlocationapproximate.md: id: c66bd4d46038 - last_write_checksum: sha1:f099221c775fd2109556ac3639c7612c48fae8cf - pristine_git_object: 2daeee0ba3640083d1cadd900a168f7d3aa9f106 + last_write_checksum: sha1:03acc3bed99b3553ff1f170f520d4f31c060a277 + pristine_git_object: 5d8ac85c787de7da613ec7c2650279bb50d4e956 eslint.config.mjs: id: 461c8d07f6da last_write_checksum: sha1:9398f326377fe47f67af2df6eb6370750c0790b4 @@ -1284,12 +1292,12 @@ trackedFiles: pristine_git_object: fe49b0d036cb4737c253de7bdd79294bb45c2890 jsr.json: id: 7f6ab7767282 - last_write_checksum: sha1:a32844da90a797c5ecd7aedc7aca129389648baf - pristine_git_object: 029e1aba29ef99d1b6bc463c75dd5a67073e318f + last_write_checksum: sha1:cee2848ee04ac72ef57a913c033725171aeed352 + pristine_git_object: 09e1d27fd104a000ed55ae5f90285d05985d21b3 package.json: id: 7030d0b2f71b - last_write_checksum: sha1:5e9dc44d73656fa94a07bbd579d7258fd8613481 - pristine_git_object: dbe4d6769292c1dcc94898c4d5ced43ee83894ee + last_write_checksum: sha1:ca883751c58afad524136f169e5bc92a40c57101 + pristine_git_object: 29d5c2ab9493f09d589af5475c7b188ec5672642 src/core.ts: id: f431fdbcd144 last_write_checksum: sha1:7fe1d083a687c984082d7324a6c70efa04ac3019 @@ -1300,8 +1308,8 @@ trackedFiles: pristine_git_object: 1b6c999e1fb3bf64003026e9d624ebaa7d9f2544 src/funcs/call.ts: id: 4e1ce51400a7 - last_write_checksum: sha1:4d376fa7c3f8fd1256ef4916035a421afe5ca13e - pristine_git_object: 068898d82c97b65e58cb8c21e9f9dfb917eb4c92 + last_write_checksum: sha1:a9d829f207cef26bd04e898e2228ee0dac25293b + pristine_git_object: 948993517dd6168a3a775e02699c154a3d633ed4 src/funcs/datasetsCreateEntry.ts: id: 0f3184b43501 last_write_checksum: sha1:b4e714c80a3f3ff5b6f10e398308053f6324bcb5 @@ -1480,16 +1488,16 @@ trackedFiles: pristine_git_object: 467c836838529cb35c016bbf632143d33e512c9e src/funcs/languageModelsRegisterCustom.ts: id: a78368a1a0d9 - last_write_checksum: sha1:3f56bbf4d82c19bcbfe47a2e11dedb2efebf6874 - pristine_git_object: 91f843c363e2c8c97ab2a1e2c13aea897193c6b5 + last_write_checksum: sha1:5b2016678083d36ad2b5592e3e3f747f97905c2f + pristine_git_object: 98903c8d1241192e6e893e13d90cd3508fc6c8aa src/funcs/languageModelsUpdateAlias.ts: id: 7d90d517bd39 last_write_checksum: sha1:b58a472dce51a095d27561b5866405f8f132e3f2 pristine_git_object: 2422c139dce53b6e236b035621dcebad229892d6 src/funcs/languageModelsUpdateCustom.ts: id: 754dd3fe0dcd - last_write_checksum: sha1:d679447c078f00950b1ee5b4bd555f87a5a637f3 - pristine_git_object: b7b74805419a4d0485c14ea0771c92edb61064b2 + last_write_checksum: sha1:1668d3febf6a67666328f79f9a09fdb617288894 + pristine_git_object: 12d054e68533a0afd9ab985627eb2132b69a735a src/funcs/ocrListOcrModelsOcrModelsGet.ts: id: 5e1c3462e76a last_write_checksum: sha1:1cf061753b4c0933cc685a905c96cbfe9165f57a @@ -1556,8 +1564,8 @@ trackedFiles: pristine_git_object: f1f86b5b0869d96055fd6ce5340f690128fe1441 src/funcs/stream.ts: id: cbe6de6fe85b - last_write_checksum: sha1:171e09db7c1ede33922eb41d95026627610e4d0e - pristine_git_object: 20697093db8ee682747ff005e6d5d1679acafac1 + last_write_checksum: sha1:2b4cb2f70afea96aab418cc8e98ac9868d6ce3ed + pristine_git_object: 1b162cb6db79b2bcb6ff18bbbe10a9a724579fca src/funcs/tracesGet.ts: id: f68b9e361165 last_write_checksum: sha1:385ebf632a53f39082bd4d879307302221ba7643 @@ -1588,8 +1596,8 @@ trackedFiles: pristine_git_object: 0aebd8b0a4867e35cb3348fc52921c3c0b4725b7 src/lib/config.ts: id: 320761608fb3 - last_write_checksum: sha1:6db96ee9f023e595f0af87d37558c21faa713794 - pristine_git_object: 7d8478ec487b3d2f106dafd22c85cf72246ab426 + last_write_checksum: sha1:215880010a7c9f4af76fdefefc64caebb7417e0b + pristine_git_object: d8f14ffa19ff1a20f18634936ea612d6012a4763 src/lib/dlv.ts: id: b1988214835a last_write_checksum: sha1:1dd3e3fbb4550c4bf31f5ef997faff355d6f3250 @@ -1640,8 +1648,8 @@ trackedFiles: pristine_git_object: 47edb9725c2482c667e2ddc8a56b1fec4285c492 src/lib/sdks.ts: id: 8a6d91f1218d - last_write_checksum: sha1:f7db2d55ac9f5280a24b1b242779b6a231602289 - pristine_git_object: e90348cc7f8959614e2f0e67e89740d9f1415727 + last_write_checksum: sha1:bfcd51a60e2c11e03aeb8ce0772a2b3d34b191a7 + pristine_git_object: f96b5799df1b2450c894d2f2287d3f1eca5467e8 src/lib/security.ts: id: 0502afa7922e last_write_checksum: sha1:119ceae76323648a76e7e78c3a7cdbeaf9c1ccfd @@ -1676,8 +1684,8 @@ trackedFiles: pristine_git_object: 0955a573c2ce989d63c737410ab8cc28706d9f74 src/mcp-server/mcp-server.ts: id: aabbc4ab07c1 - last_write_checksum: sha1:630b11682e88bac36bbc88ec0ebb43823518b683 - pristine_git_object: 8df222da77bfab5b06933a886c14f53bae5dfbba + last_write_checksum: sha1:c22a980ca9d795c6ae4794939aa6c20c863594c7 + pristine_git_object: ed9ca8f4611ed0609bdef4ef55d572c506e5024f src/mcp-server/prompts.ts: id: 26f3d73cbf31 last_write_checksum: sha1:aab17727e4e0e625fffd088ba2943d9700e6c049 @@ -1692,8 +1700,8 @@ trackedFiles: pristine_git_object: c25696d4c4f70e081fa5d87ad6891874c509a577 src/mcp-server/server.ts: id: 2784dd48e82a - last_write_checksum: sha1:3ff63519ef2de8f1ea71a2a8d4d8e9ddb43d4e5f - pristine_git_object: 4513112dfd7a8da6011287fa82d88b03ab44943c + last_write_checksum: sha1:78fb732c2f1005f3b043592fba3e0b2b39a5166e + pristine_git_object: e3308bfa9ad2483f79e6a186ff6b6a5283c7ff9e src/mcp-server/shared.ts: id: 074e80d4be1e last_write_checksum: sha1:56c73d4429691516e35541825e759a0285747a2b @@ -1708,8 +1716,8 @@ trackedFiles: pristine_git_object: 2154577ceb7e8d9cff281b922d22a1c5329dfd11 src/mcp-server/tools/call.ts: id: 7ab1495f591e - last_write_checksum: sha1:5f17448fa1c0960e93a93a6cddd39a170cc8d418 - pristine_git_object: ac818fd9563d74fd472fe2162a8857872d0fa8b5 + last_write_checksum: sha1:c93d981e4090b9580ff33623f3914938129aa4d4 + pristine_git_object: 2c0c83b9db128949b11b348b8c7a01eb92e17c7b src/mcp-server/tools/datasetsCreateEntry.ts: id: af7e31bf7e49 last_write_checksum: sha1:43fc1bff69df0ee90d724097bd0545ca9c5e0fad @@ -1888,16 +1896,16 @@ trackedFiles: pristine_git_object: 3664c834919e5a01313dac926b13ad0c68df2026 src/mcp-server/tools/languageModelsRegisterCustom.ts: id: 00cc3ca2b919 - last_write_checksum: sha1:ab72a02c9f00a784212c2c4c309e648c8170d207 - pristine_git_object: 3a1fb222d7e82b2c6e9519665554610d2d39e860 + last_write_checksum: sha1:2ba93e0ac7a429cf5fb4ec2ed267f29089240add + pristine_git_object: 3b98d3b9e797eb5b4b595127a070312a4e817c9b src/mcp-server/tools/languageModelsUpdateAlias.ts: id: 05d54e42622e last_write_checksum: sha1:eb55099e3a924d2be2817690754d58a885a04250 pristine_git_object: 0181316a419b2a4418c66011430142ce5e504196 src/mcp-server/tools/languageModelsUpdateCustom.ts: id: fbe90be117f8 - last_write_checksum: sha1:ef716aea9e1e69c867708e0524207a6f7ccfe3ab - pristine_git_object: 470ea10a196ed98639761ac44ac4485bb308c975 + last_write_checksum: sha1:ffb56474171b643c36b14200196147dd8df30d5d + pristine_git_object: c01a1774bf990e525589435b471db1b9539f0814 src/mcp-server/tools/ocrListOcrModelsOcrModelsGet.ts: id: 721200f7de9e last_write_checksum: sha1:442a5f7300deda2abb4901aab166a453be3b2ceb @@ -1964,8 +1972,8 @@ trackedFiles: pristine_git_object: b868ca9dc8d19581bdb5263c95695e448e7866e4 src/mcp-server/tools/stream.ts: id: 3ca601f0e9ed - last_write_checksum: sha1:8db1e89337d01f1994af7dc4f5a73aeb478a3df1 - pristine_git_object: ee7c1e002f8d7d1ff6e77a5cce3ea23a28f6b036 + last_write_checksum: sha1:5c9b2e638289df82131b777c904ea42d49ec262a + pristine_git_object: d83d11c01a9b449d32946cce9621cf80f3dc7dd5 src/mcp-server/tools/tracesGet.ts: id: 42492f3ff12c last_write_checksum: sha1:fe0a6928963e4962e1f456a462686f299ef0db93 @@ -1980,20 +1988,12 @@ trackedFiles: pristine_git_object: 6935e794844a67a791b737da275e75b6427d9e8e src/models/annotation.ts: id: "154996783512" - last_write_checksum: sha1:2fd69c737e40a941ee3950cab7ac685a0ae9c744 - pristine_git_object: ee1fbcd632deb325e3a20a688d0b1c4ac3e5a476 + last_write_checksum: sha1:7b6cba8cc346b274c6f81a80120381afbede3797 + pristine_git_object: 69727692f84d3e3fd033b87911351b89875c0d58 src/models/annotationurlcitation.ts: id: 895bf7dfa898 - last_write_checksum: sha1:f99500a572eeb48526b1b696941eb8362ae90c86 - pristine_git_object: f60420de3f08bdc90eae584fae28fbda93a7e3d0 - src/models/appapipublicv2functioncallcallfunctionrequest.ts: - id: b2209fa1addc - last_write_checksum: sha1:f7336623a39952be54505834e5302db55df856d6 - pristine_git_object: 90e2bf0a4494b6fc3834a608cce0beaaf56b49e5 - src/models/appapipublicv2functioncallcallfunctionresponse.ts: - id: bc9b70199c5a - last_write_checksum: sha1:bc89171dc945ade15b64b261d963bfcdfbda75a2 - pristine_git_object: ddef5eb27611638b7db28433f1b6dbe0a6ac4d0d + last_write_checksum: sha1:7b346f4b4ae152767ed6297572b6f1b5a2b3997c + pristine_git_object: bc6d6036f8e3ed7b6afaf9941c70ebfd5cba3d55 src/models/appapipublicv2functionscallfunctionrequest.ts: id: cfc6ca65127c last_write_checksum: sha1:21a85c34b00e3a3568d368314efbdbbf9f98d039 @@ -2004,120 +2004,128 @@ trackedFiles: pristine_git_object: bdc3b95d9a0b50ce240e5f28e73bc8b54adfadc3 src/models/audio.ts: id: 4b0a8214f90e - last_write_checksum: sha1:ab7ccb9e3da028e8d174b677c5cd5b495c933265 - pristine_git_object: dc5d9095908ca2b583c8b582366213157ac57d6e + last_write_checksum: sha1:0dd001d86a1b046a043e710eb14b3cd378d4257d + pristine_git_object: 340dc878356c6f433955d68b111a68e0fcb7cab5 src/models/bodyuploadfileknowledgeknowledgebaseiduploadpost.ts: id: 16bf9a5901fb last_write_checksum: sha1:7ab25367090caeb3260862b5e2a3067dee8a17e8 pristine_git_object: 07a13149845ba2a8e85708661cfe2776757c4928 + src/models/callfunctionrequest.ts: + id: e0432cc8379c + last_write_checksum: sha1:c792e47172cb7c2095d580e0cfecc4b0236ecb75 + pristine_git_object: 8d377adf69e5ee0c3aa2b68251c51aa58bde050a + src/models/callfunctionresponse.ts: + id: 9c7a1c14567a + last_write_checksum: sha1:eaf9e178a5922c735e927202435e327fdb1f4529 + pristine_git_object: a0e8a9549f30dd055025f104ac8a71e68f60f7bb src/models/chatcompletion.ts: id: 92c8e8bb5ac2 - last_write_checksum: sha1:afd602d8f1b3a3d8c78dd639f84634b775c807dd - pristine_git_object: 088a344f8b77d45a66bd22564772775b0612a236 + last_write_checksum: sha1:08203ac4840f5a979b7fda9e05a96fe1121a1c84 + pristine_git_object: b5e0eaf375a61aa39866b76e92cb97830770c616 src/models/chatcompletionallowedtoolchoiceparam.ts: id: 1aa24512d96c - last_write_checksum: sha1:2acf9e16227bdb328bd1f40bf0aa577542fae330 - pristine_git_object: 03882ec6df2aaa7a370c4ef3f65620df1ffe380f + last_write_checksum: sha1:59a1ca92f1059ca61e264fae53f335d341510a07 + pristine_git_object: 832e5eef074d75a3fafb63dacae600da1f6c46de src/models/chatcompletionallowedtoolsparam.ts: id: 3faec20c8037 - last_write_checksum: sha1:2aec299f076f05c95f66b7454eb7129b8d5b91a2 - pristine_git_object: c2f6740ed18b128a7a8a8b49a86dcca48e11496e + last_write_checksum: sha1:64f8fd2ecfc765de8f9dd0b34a0a218413ed4074 + pristine_git_object: fee3108d5e6146225dcbd21d3423b2bb6557592a src/models/chatcompletionassistantmessageparam.ts: id: c7711ad60d84 - last_write_checksum: sha1:cb3f4b40902d20792ae47ae8ad92405f2728ff65 - pristine_git_object: 7f2216b58b371f91c396f8cfb6f68842de17bc0d + last_write_checksum: sha1:4981c2ccd0268f1d1ba4fc41abe655a1007d683c + pristine_git_object: 8f8423908bca7a823d721eb64ee8b4794cf7ac78 src/models/chatcompletionaudio.ts: id: cd4a67ba6dce - last_write_checksum: sha1:a1c287cfe7281a74276b9e66e4c0a98583483bfc - pristine_git_object: 895976f560d13ad1ac26d7016bee8042b3325eec + last_write_checksum: sha1:fa6f94fdce99549f1cffca8090fe1c7c0fff0dcf + pristine_git_object: e0aa378ecfd647beb02f3e2711c476ef5e890f6e src/models/chatcompletionaudioparam.ts: id: ae6eb9bc4505 - last_write_checksum: sha1:5e21693c6772dcf2943d7485935f6c7d3b8762f7 - pristine_git_object: 9f05ab398b6abdd0b35dd922700fe667cbca10fc + last_write_checksum: sha1:2f840e3c95a072578c863d83f33f06b978094612 + pristine_git_object: ee8f36d83a10fcc9d9a312aa279022ac06674dd7 src/models/chatcompletioncontentpartimageparam.ts: id: 21b5ffd74f6f - last_write_checksum: sha1:dfa9d7b64a9be3bdcf46940481e9922aec9d5c21 - pristine_git_object: 106f92d05ef84a2b997cc2d3d5d6dc6dc0db0883 + last_write_checksum: sha1:99ded354afae1bddc5add4710f35aab9f79735ad + pristine_git_object: 4fe3d2ba588b3c44e5d08510d91f40cde3731d8d src/models/chatcompletioncontentpartinputaudioparam.ts: id: 800293d5a9a6 - last_write_checksum: sha1:0fc6ea55c542d080b4089dace8f5902ce03d34ff - pristine_git_object: dbdf214052e7e07c66ed72cdf78be8be4354daa5 + last_write_checksum: sha1:2f30153699bf7c5015c2ecdd1a778be819612f0b + pristine_git_object: 7722f714842a5573b3acb5b1c28050946ed44446 src/models/chatcompletioncontentpartrefusalparam.ts: id: 1c0286d547ed last_write_checksum: sha1:a1370cd5ef80d7fd1193ec17e451046f0af76f97 pristine_git_object: 0e8ae02e009a0e35ef089694937561942ea364fc src/models/chatcompletioncontentparttextparam.ts: id: 09643c36a2d6 - last_write_checksum: sha1:a4d10f227daec64f32803d0362df550951f15318 - pristine_git_object: 76e32320d34e8527706d2c7a188706deb65660d4 + last_write_checksum: sha1:01aa33c14343e32ec762987be7b6f68450841ea2 + pristine_git_object: ba04c044c3d99edf653353254e3f30bf6644e13e src/models/chatcompletioncustomtoolparam.ts: id: fccd964a4304 - last_write_checksum: sha1:85472473b8b3c69ff5b113ece3ef3efe75baa2a0 - pristine_git_object: 297e9cd38dd944b9d148bb8df7883c24d0ed7959 + last_write_checksum: sha1:6bf9b1035f02e57597794bc89be4563b352ff429 + pristine_git_object: 53ec79fc21482639136d3e81c38fc7ac6ee8f9e4 src/models/chatcompletiondevelopermessageparam.ts: id: c30d9cbacaa2 - last_write_checksum: sha1:6c1852e1ba12cc3aeaa4192a31fa50957a248f3a - pristine_git_object: 3e8f7386d4d03117a25eddd9964578ceb7c6cf8a + last_write_checksum: sha1:571393a99d401699fa2d2925082d102a366775fd + pristine_git_object: 582ed4c109462e1c8b123f77e472ce24a531a1ae src/models/chatcompletionfunctioncalloptionparam.ts: id: fc48763beb7e - last_write_checksum: sha1:fb6d43cd583d08ce9ab9f106e5570ab4ac4089f1 - pristine_git_object: 56fbf8e9f185b9936137402c9ca74806db07ccd0 + last_write_checksum: sha1:c271e53dd8898b8c19e0a082043c970a8050670e + pristine_git_object: bebae7f512bf68a5501b3e0999dbfcfb8b948583 src/models/chatcompletionfunctionmessageparam.ts: id: 6cd067be1819 last_write_checksum: sha1:831a52f871f2416a0b38fcabcebcf259023665c7 pristine_git_object: 62238c855689d6d1b4a3b01e3e162be4e8bcfa1e src/models/chatcompletionfunctiontoolparam.ts: id: e45f3050615a - last_write_checksum: sha1:200b5f78a93884025f2cf5a911fbeeb5b8d58b52 - pristine_git_object: 9528caa015a1c72d9bf09e3939d1f139368a795f + last_write_checksum: sha1:59e2a08ef6b2614497a866b16a5227271c591fa9 + pristine_git_object: 45e46498b5ee3b98990702d5d7defeccb0a8f590 src/models/chatcompletionmessage.ts: id: a42b4acd1a1d - last_write_checksum: sha1:c4da04fd280cce7ef2c39f9e87ca7fd1a78099ff - pristine_git_object: cd85096e434c71b007b70d88658cd7c1a01519e3 + last_write_checksum: sha1:3ed897cbc2c356b69cdd9e87ef3087595132c2ac + pristine_git_object: 63b050924fdedc718291f224b38a36f20f4bfc40 src/models/chatcompletionmessagecustomtoolcall.ts: id: 519069b45dd1 - last_write_checksum: sha1:ac24f7d56c687f4b318d5e8a1de84313f81d84c3 - pristine_git_object: c9b7a1e86f722d01728b371e3df9719e778e4eae + last_write_checksum: sha1:b7ac35fc64af107841876e79e901700b07ce84f4 + pristine_git_object: 2d473f73391f08cf013f0abeb059c0feb5e8232a src/models/chatcompletionmessagecustomtoolcallparam.ts: id: 3fa91f2449f1 - last_write_checksum: sha1:ed306e0f9831792271fbd79946a6a4f76d47fc9b - pristine_git_object: 9fa8e1ae6fab0dbaf704111e915388b6ee35fe82 + last_write_checksum: sha1:bee5bbd413f965d13cf8a718d8d29b281826fdf4 + pristine_git_object: 66ee754ca186c11f5e1c5fa8281ff9c30c7299a8 src/models/chatcompletionmessagefunctiontoolcall.ts: id: 88c888125c56 - last_write_checksum: sha1:c57a0e33829b5237a6f54d49ba9c74898fe18d3b - pristine_git_object: ed6beaadc7f231cf21d85f7135eafdd78bdb9502 + last_write_checksum: sha1:7f43c9ec30a401ddf3465d530b5a0603a061da10 + pristine_git_object: 7c258c796a2030aabbea5ec2e7874b3ee83156db src/models/chatcompletionmessagefunctiontoolcallparam.ts: id: ebb57e9df9e5 - last_write_checksum: sha1:f4907a75e8c775436fce535383d4e563817591b3 - pristine_git_object: bc146a118c73df82509b9858234b1c2beec97000 + last_write_checksum: sha1:4230a418c9dead1d98705a71a114e9dd2d528216 + pristine_git_object: 3145fe3d64ff3815ea3604577430734750f63ecf src/models/chatcompletionnamedtoolchoicecustomparam.ts: id: ce9af7e698ad - last_write_checksum: sha1:5c0be99e15ad80e2945d3aa6f338877a6677edbe - pristine_git_object: b1a1b1142ac170e7ae1339c59f855d59ebe53dd1 + last_write_checksum: sha1:50cfe4a7603f9ceaed7828ec98939afa12a368f2 + pristine_git_object: fffd8356ba3781cde5d95647931d5e73e6baaf7d src/models/chatcompletionnamedtoolchoiceparam.ts: id: 6cf82ddeafec - last_write_checksum: sha1:81f3ae850e00a8c7c05cdd4f09bb58af1dba0e36 - pristine_git_object: 18f7b03e34456d1674be2838974ce9656d69a768 + last_write_checksum: sha1:e681fe405df73a855245db0aaa3643035b99be72 + pristine_git_object: c6bdadc40466747875727355219b458716195260 src/models/chatcompletionnonstreaming.ts: id: fac6c1131324 - last_write_checksum: sha1:a6f56012cab520da14cf9052b2ce3a9dc5288786 - pristine_git_object: ea68bd8bc54b54d05d8307fb6074e33ee66e5b31 + last_write_checksum: sha1:acacce07e860ab78eb8f008427977811d9363741 + pristine_git_object: cc2a8e3deff74affb72c044a5e8cd393d7d16180 src/models/chatcompletionpredictioncontentparam.ts: id: 9295c97a4ecb - last_write_checksum: sha1:252cd230390cd7e0a604081931d804b1248884cf - pristine_git_object: 742bedf1b0c017e05140c3ed33cb13825123767c + last_write_checksum: sha1:9795b2fd76b010039743d19846740c648d53b5c5 + pristine_git_object: 7b1b24081226719a27af584377e02299ca327e82 src/models/chatcompletionstreaming.ts: id: edca9474148c - last_write_checksum: sha1:dd0e3ec1b7ffa9a91804ea8939d49a3fb1cd726d - pristine_git_object: cdbbf5100fb0a14d61f64bb2630aa780818845cd + last_write_checksum: sha1:0fade502bcf83b9167f0582ae0ad1eeb1c0d7f78 + pristine_git_object: 8dca463b5048a46daa4cfaa8ad145b8e7ad7fe29 src/models/chatcompletionstreamoptionsparam.ts: id: 8eecbef20df4 - last_write_checksum: sha1:1b910381c9eef245cf110f4691002235ffb129c5 - pristine_git_object: 879167b82ecbf64ad70d60e168ce1984a9a48d0a + last_write_checksum: sha1:6a619699407f7417518443f04b22bf24faa38d62 + pristine_git_object: 226ba9c55c084f49cea60f5684fb66f0063f11e5 src/models/chatcompletionsystemmessageparam.ts: id: 4ba7460abb5c - last_write_checksum: sha1:4200265e07a7ad9862d41006721537a4e852f3b4 - pristine_git_object: 783b5013d370534fc223e96ebcab7271f3c078af + last_write_checksum: sha1:9690308f60fbd6ff015f889aff39b9fbe1c223d6 + pristine_git_object: 57acb7fca467fc083a79d1a99e0792f698cf48bd src/models/chatcompletiontokenlogprob.ts: id: 118f4ff16855 last_write_checksum: sha1:eb41e57939e7fcad543d51004d69188bf12d6e38 @@ -2128,24 +2136,24 @@ trackedFiles: pristine_git_object: 1c717375e13cfc57fe31a39a530f0c8cacf010c7 src/models/chatcompletionusermessageparam.ts: id: 0f2ac198b0c3 - last_write_checksum: sha1:7eb2220d73feed823d7200247a34c089b6f47813 - pristine_git_object: 909ae302e050b96ec1d3a7c74531a7013877884e + last_write_checksum: sha1:101455613b01b8d32be73ab4798689f7b69f4dc9 + pristine_git_object: 8c17b41fd9f6824d13bac9c2dcccf04a9aaf27c4 src/models/choice.ts: id: 72ad68052e8a - last_write_checksum: sha1:a385cf3492b7a26183b1632bcbffb399ddcc7b9d - pristine_git_object: bfae54367b1a4fc46e38bf77a5a2e0bf0b7b2cad + last_write_checksum: sha1:e5c1b2f0f797f6d8b0004949366f29658c80c919 + pristine_git_object: bf450e7327841941daea8d735c8ac659bb87c4b4 src/models/choicelogprobs.ts: id: f2eedd9721a5 - last_write_checksum: sha1:848c3aa60f5f0ace9eb4a3d51600ecea856bbc7f - pristine_git_object: 9dbb1ab4fd47ce4a356d35459902c06ae5abe806 + last_write_checksum: sha1:18f739eeb2a16b68a3364ec6692a9a303ba54b78 + pristine_git_object: a6246ccd7c5f9bed918c477e545e3ad4d68dedf5 src/models/completiontokensdetails.ts: id: cb0229099440 - last_write_checksum: sha1:0fa66ef5d11d5feea3e284428b60bbef55bf50be - pristine_git_object: f3deeb26c65df92e6c92f41adfb3cf88e9b26ea0 + last_write_checksum: sha1:143ae1f18ad2e704f0bc5bf4cfcae644cbf752fc + pristine_git_object: 4e57c875bbf5a1f6b70b23e8772cfcd5fed7cded src/models/completionusage.ts: id: 4a222248409d - last_write_checksum: sha1:2e8ea41f7036fe960d14c4ca5b7542de4846beef - pristine_git_object: 29befa9d7bfabb55c35038b07cdfc854734f4d6c + last_write_checksum: sha1:5a6633afd63dbe19ee23b2c489e2b18f0759597a + pristine_git_object: 6afb7478762c994e960f4aeaf8fbd73a1020db3c src/models/createdatasetentryrequest.ts: id: 7fa20174b22c last_write_checksum: sha1:fc951134f9821a3b282447c39d75ef8c1e725433 @@ -2204,20 +2212,20 @@ trackedFiles: pristine_git_object: 7b7f27b1f4b8e4a959c6df99d77fb2035f35eded src/models/customformatgrammar.ts: id: 49af13396242 - last_write_checksum: sha1:b232ee49c93c3cad339f9a0680d97ba70025d3e6 - pristine_git_object: 48bf703d679f8cc2a615439f1c2f8a5014ee7c29 + last_write_checksum: sha1:331a76df2f8235811f45f30f4ff32accb3bc066d + pristine_git_object: f7da55c59a698d87f3e8b9ad12dbfcf585939ee4 src/models/customformatgrammargrammar.ts: id: 5573ba87bb14 - last_write_checksum: sha1:f8579b7351c02e43903b1a650fd6f5776661a46a - pristine_git_object: edf7b0d2611e9e39eecb70fbd1d78890d09dc9d0 + last_write_checksum: sha1:a67b90e817a8ac148bee8ac226f82f852c784ddf + pristine_git_object: 45e1cec42632abde02ed87454fda3d573a1db38b src/models/customformattext.ts: id: 9f4416e3f035 - last_write_checksum: sha1:2b7aa7a982d59376f173c3cc1fa0acc0b454dbb9 - pristine_git_object: 93b34d33504506800a25f4a5051a1ea58a9918ab + last_write_checksum: sha1:8b3d86210c0a0da84334fb4f51046d80f571c90f + pristine_git_object: abe905b1f66f81162504bfcdd7f09eedf306149e src/models/customoutput.ts: id: c5804f582828 - last_write_checksum: sha1:2f62e098af25b24751045500823adb6987abc26f - pristine_git_object: 13953418eebe91741284e7ccf43d7a299553894a + last_write_checksum: sha1:de7e5672893a7b4b0b24ef5a9e6db6d36a58242e + pristine_git_object: f6e928141ea567d8538c45224cec33064624c31f src/models/deleteknowledgebaserequest.ts: id: 9f8bbdfa3098 last_write_checksum: sha1:5e33245f595bded75447648cb87dc7477f6d0d09 @@ -2292,8 +2300,8 @@ trackedFiles: pristine_git_object: b922c262bb6133c034a39419f902665debd49595 src/models/file.ts: id: 6b94c427e8dc - last_write_checksum: sha1:9b87b16439bad3a7e88a39cdccf627ef82b3c0db - pristine_git_object: 40138830654e72f6ca9dfd64a0fce3ee997621fd + last_write_checksum: sha1:1bf9dbcff7b934da69a01fa880f248e0b9b756df + pristine_git_object: bfefabaec3a75f5edceb85b865a295a574a0a59c src/models/filedownloadurlresponse.ts: id: e2fefea3b20f last_write_checksum: sha1:459b1cce6b57789650c330c1110291fa0c9fcc95 @@ -2316,20 +2324,20 @@ trackedFiles: pristine_git_object: e7772fac67c3a930e5629aac5c6ab0fda8d9bf01 src/models/functioncallinput.ts: id: 38bd6f9398e2 - last_write_checksum: sha1:0516faba0cb1a5a5ae1d189a7d8fdba87d8e51f2 - pristine_git_object: 917172c95b427f14898a50c12710a7647aac991f + last_write_checksum: sha1:ded54cb14490d04bd090fbbc4355d32c198c088d + pristine_git_object: 136c4729361795ddb9ba4ad642ab4c80525b125f src/models/functioncalloutput.ts: id: 3dacd3bac7e0 - last_write_checksum: sha1:e9b5b836b5f5a031a89d67e97c6edb2011d9105d - pristine_git_object: 929ea76d0f0e93dfc2ce8e97243964d174a793aa + last_write_checksum: sha1:3d8f64ef284e6f3559bfbbab0b7e4ac1fbcc7b97 + pristine_git_object: 3a95d4176ad624c491a21ee3ddf01758637aa2f3 src/models/functiondefinition.ts: id: 1e19fd0c1e0c last_write_checksum: sha1:097f27eb9bea1a6bfe5a35630a81cac906fdf3fd pristine_git_object: b260b0981fbf0c5c2ffdf1d2d07eace447c18a8a src/models/functionoutput.ts: id: c2760df20cc2 - last_write_checksum: sha1:4dea3016523d8922ad59acbf54314af3b3424b7e - pristine_git_object: 1b8bec55cdf5e9422cd794f82da90daa895f25de + last_write_checksum: sha1:e6db7367013e88cd587da6de702687794cbd414b + pristine_git_object: dbb5265b502f9411e95de565fb941d591b6f92af src/models/getcustommodelresponse.ts: id: d51eeaefed38 last_write_checksum: sha1:749dcfc6cc5e4ec0389bc076063888644f000cad @@ -2388,16 +2396,16 @@ trackedFiles: pristine_git_object: 61690cc62ba68deb1c15e548bf466dbf815de24b src/models/index.ts: id: f93644b0f37e - last_write_checksum: sha1:c26720b1ea4b6e33fc06e2a35d62aed2d25e5a81 - pristine_git_object: 60b3a6acc6559d117716f6b57946a04be5657c68 + last_write_checksum: sha1:6d228a1bb01e1afade793e24869873c9d5aaca97 + pristine_git_object: daf80d2db491487470382a27690c2854ddf5a1a6 src/models/inputaudio.ts: id: 9bdc14c7565f last_write_checksum: sha1:cbdd2b85ee862c49ab572f2a402be112b7d21c0a pristine_git_object: d1bbaa90c01ea4d2f8e1b1e4374bc29a676d90eb src/models/jsonschema.ts: id: 847b89e5c5de - last_write_checksum: sha1:014d43719bd8890f606f2fb6c7f7240ebf8cbab4 - pristine_git_object: 670b7291828694a15055c4ac17412f449852809a + last_write_checksum: sha1:d24c610a2dedc852f98d92d5b0552e547781ddf6 + pristine_git_object: 3073f3982e29b7662511abdeab348579f9a250d4 src/models/listcustommodelsresponseitem.ts: id: 5728302b688f last_write_checksum: sha1:a6f7b770490499e29e95191d9d422b0ba2e0a3e1 @@ -2492,16 +2500,16 @@ trackedFiles: pristine_git_object: 58da15d0c3aaa4713959b65455623f1c20a3abfe src/models/openaitypeschatchatcompletioncustomtoolparamcustom.ts: id: 98b1820d5772 - last_write_checksum: sha1:9ebbc1a90924335608808b8e96021aa60f70d74c - pristine_git_object: b5b8319911eaca1a6a84db6a63e986fad005b28f + last_write_checksum: sha1:909977f07e021a95ef12949c43cdafb9fa0590c7 + pristine_git_object: e3a43fc10062b0684792a1506f48cc7e4bf46a42 src/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.ts: id: 01d98a8fb574 - last_write_checksum: sha1:47202136d49be4eef21874326706957e7500d0b6 - pristine_git_object: c4ba71b219bb70f879cf70cd0f9bf480aeaf3cc8 + last_write_checksum: sha1:f624c5fe220929fda29e8d934cfe3575bf6b1aea + pristine_git_object: 0177e705feb68237c29251263dd704a33526a588 src/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.ts: id: 65545ebb10b8 - last_write_checksum: sha1:cc24e7f890c4d467f3c5987f1470eac031532f65 - pristine_git_object: c404a07d011443e3f3b825e441f463f9786fe9bc + last_write_checksum: sha1:f0ca261affd7651eb6aba0e683e8edb347a3571f + pristine_git_object: afb7684ec486ef780c131a20f3889c77886096db src/models/openaitypeschatchatcompletionnamedtoolchoicecustomparamcustom.ts: id: eef42d309087 last_write_checksum: sha1:50762cd69cb9e92520361f46ae96428b207d25db @@ -2796,8 +2804,8 @@ trackedFiles: pristine_git_object: 8d99b6e986a59a140377bc0d5d74484512bcaf6b src/models/prompttokensdetails.ts: id: f6a8f5d8d09b - last_write_checksum: sha1:fb3de1157f13f6af8248e148f9c3533e36d8b0c8 - pristine_git_object: d22c01ac4532496741a0ab1440d5b9ddd581170a + last_write_checksum: sha1:1599b4e0ca1213430944f52fb05510d71f2a9f24 + pristine_git_object: 27948556741746940ad4918f2c274dbf1f4d366a src/models/querydatasetentriesresponse.ts: id: 2da742f8ceda last_write_checksum: sha1:bd3c4a08dd5995732090a3a7a8d86b7255030de8 @@ -2848,16 +2856,16 @@ trackedFiles: pristine_git_object: da54c9c8efb41414fb977bb99564536c081b6a46 src/models/responseformatjsonobject.ts: id: ae5419a9e494 - last_write_checksum: sha1:33db9a6a8b14bd58d82054d6d9dbcfbeddde41be - pristine_git_object: fb92f4b85059b314634fe1fb180f308dad7a4cbf + last_write_checksum: sha1:51981e7dfc8be0c91bd079f361affa67cdea8005 + pristine_git_object: 409a79d88f71d4fb351cdb79e03fd72c58743566 src/models/responseformatjsonschema.ts: id: ff0b42f802dc - last_write_checksum: sha1:dea26df436f357c5832c1315a701d23402e42a62 - pristine_git_object: 43469a6f57fbc640e1e9d40b7b037bb8d5c98747 + last_write_checksum: sha1:45fad6741fe23ad7ce65786103c98478cbe9c389 + pristine_git_object: e279ed63102c6544aab138eaf70231a046e0f875 src/models/responseformattext.ts: id: 872eaee007ec - last_write_checksum: sha1:2f0c1589b192debb802457255c627598f8264545 - pristine_git_object: fde67810bbcf13d0d9bcbbc6d33f43d656c8d270 + last_write_checksum: sha1:b4491260f451a1ba63c39598e841e4bf5a161110 + pristine_git_object: c8c2c0cfd0315908b92e9ff1e240e70845648aec src/models/savetodatasetresponse.ts: id: bb5a3ad6bfa6 last_write_checksum: sha1:3ccca1e7e001404711af93c14c92fe32dae88e8b @@ -2952,16 +2960,16 @@ trackedFiles: pristine_git_object: 2270c556702227bbad7650f8acceff843a41090a src/models/websearchoptions.ts: id: ae8f3959df1c - last_write_checksum: sha1:8a9c3bf41e8409d8efeafd65dc43eef204358c16 - pristine_git_object: 280e0ed7d3e82d492cae6664bb08797f42472598 + last_write_checksum: sha1:ea87f0856262b9039499b4b57bae49152a408d3d + pristine_git_object: a55a3307131883b2d5cbf0cd8f9dd4ef1b4d5b51 src/models/websearchoptionsuserlocation.ts: id: 46d6a153a80a - last_write_checksum: sha1:1c1090b0e3137df955187252f8d76aac1476d873 - pristine_git_object: fb335e9992f7e9cdacad81e870ef1adc8ed67b18 + last_write_checksum: sha1:e58f2bc73c227a205b6d4710769af819d8171fe3 + pristine_git_object: 3013a7cfff62712e2f25aa88f1943a03725f64a6 src/models/websearchoptionsuserlocationapproximate.ts: id: b8d608734838 - last_write_checksum: sha1:a986bfb22e959feffd7a793fcf9f84c98edc7fb3 - pristine_git_object: d8b3d31e1e2748607ef44c52dd76f419b68ea689 + last_write_checksum: sha1:e8741fcc0026e57953aefc75d840c158af6c0406 + pristine_git_object: b5e8543327ddfe40d1b6626fbae241eb78597817 src/sdk/analytics.ts: id: 411d91261be3 last_write_checksum: sha1:8e9b3ffa697fc48d7d37fedc53709d71d9751fb7 @@ -2992,8 +3000,8 @@ trackedFiles: pristine_git_object: abd9031cf31283312ddde69e3e952d63bdfd3296 src/sdk/languagemodels.ts: id: c375504a88ed - last_write_checksum: sha1:2fd11f3b1ddc63587b4e26272342c7b6021ffa7f - pristine_git_object: e8f024e724b2821b97c1b37c20b1a54a9e3d0bae + last_write_checksum: sha1:0b80f27a98189af65dd0888d12b08acab83f758e + pristine_git_object: 8f7efc41b3c4ea94e239a050347ae73b1e035ed7 src/sdk/ocr.ts: id: 75d7fe4f0002 last_write_checksum: sha1:fb5a7c4c608acd6f0f7fc5c07a56dfa55b7f9f26 @@ -3012,8 +3020,8 @@ trackedFiles: pristine_git_object: 5869bac1e088a87e0e332d7062fbf06c50dee14d src/sdk/sdk.ts: id: 784571af2f69 - last_write_checksum: sha1:74b472a6339a54d166ebb3ae3cd21fa14f907739 - pristine_git_object: 92bc74075d36a8694e762a7fd3d7dc406b95551c + last_write_checksum: sha1:7f043cf06a82a7a96f914c97c3e1e9e6b4c9256d + pristine_git_object: 0e459a378a670f11185590c2d1d71e348ba4e768 src/sdk/spanmetrics.ts: id: 273ced1995d4 last_write_checksum: sha1:591300ee66cfb61b181225004ccfa68ddbb05ff6 @@ -3348,7 +3356,7 @@ examples: path: span_id: "77b258a2-45c1-4b87-a50c-9116bc8ed1d6" requestBody: - application/json: {"name": "my span", "start_time": "2026-01-02T11:36:47.278310Z", "type": "email_tool", "end_time": "2026-01-02T11:36:47.278372Z", "input": "Hello, world!", "output": "Hello, world!", "error": "Exception: This is an error message", "meta": {"key": "value"}, "score": 10} + application/json: {"name": "my span", "start_time": "2026-02-02T03:09:03.441704Z", "type": "email_tool", "end_time": "2026-02-02T03:09:03.441764Z", "input": "Hello, world!", "output": "Hello, world!", "error": "Exception: This is an error message", "meta": {"key": "value"}, "score": 10} responses: "200": application/json: {"name": "my span", "start_time": "2024-03-20T10:00:00+00:00", "id": "84d9ffc8-336c-4953-b92f-fe05d5405951", "trace_id": "123e4567-e89b-12d3-a456-426614174000", "parent_id": "123e4567-e89b-12d3-a456-426614174000", "type": "email_tool", "end_time": "2024-03-20T10:00:10+00:00", "input": "Hello, world!", "output": "Hello, world!", "error": "Exception: This is an error message", "meta": {"key": "value"}, "score": 10} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 5de72b5..d02e424 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -16,6 +16,7 @@ generation: requestResponseComponentNamesFeb2024: true securityFeb2025: true sharedErrorComponentsApr2025: true + sharedNestedComponentsJan2026: false auth: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: true @@ -30,7 +31,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false typescript: - version: 3.4.1 + version: 3.4.2 acceptHeaderEnum: true additionalDependencies: dependencies: {} @@ -53,6 +54,7 @@ typescript: enumFormat: union envVarPrefix: OPPER exportZodModelNamespace: false + flatAdditionalProperties: false flattenGlobalSecurity: true flatteningOrder: parameters-first formStringArrayEncodeMode: encoded-string @@ -71,6 +73,7 @@ typescript: inputModelSuffix: input jsonpath: rfc9535 laxMode: strict + legacyFileNaming: true maxMethodParams: 99 methodArguments: require-security-and-request modelPropertyCasing: camel @@ -79,6 +82,7 @@ typescript: outputModelSuffix: output packageName: opperai preApplyUnionDiscriminators: true + preserveModelFieldNames: false responseFormat: flat sseFlatResponse: false templateVersion: v2 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 40af9e3..cced2b2 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.680.11 +speakeasyVersion: 1.700.2 sources: FastAPI: sourceNamespace: fast-api - sourceRevisionDigest: sha256:68b0cbe004a918df9af2bdb9f14fb8603d166eee2514fe752773b87a0b06a602 - sourceBlobDigest: sha256:9a8a62a66b7d61f0a406be7b4c63c1b2d555b9ce44d9e3f998d10c31df1d5009 + sourceRevisionDigest: sha256:dde7c8c4035bf83cc75e28f44010eec1e876ddaab5a20c92e33ec613b63c35e6 + sourceBlobDigest: sha256:72dfdb213d9b91d6f50cc5af43f4f9d494ab47bd1dd1e34c183c0d9b4bdb37f6 tags: - latest - main @@ -12,10 +12,10 @@ targets: opper: source: FastAPI sourceNamespace: fast-api - sourceRevisionDigest: sha256:68b0cbe004a918df9af2bdb9f14fb8603d166eee2514fe752773b87a0b06a602 - sourceBlobDigest: sha256:9a8a62a66b7d61f0a406be7b4c63c1b2d555b9ce44d9e3f998d10c31df1d5009 + sourceRevisionDigest: sha256:dde7c8c4035bf83cc75e28f44010eec1e876ddaab5a20c92e33ec613b63c35e6 + sourceBlobDigest: sha256:72dfdb213d9b91d6f50cc5af43f4f9d494ab47bd1dd1e34c183c0d9b4bdb37f6 codeSamplesNamespace: fast-api-typescript-code-samples - codeSamplesRevisionDigest: sha256:5c5b7fb4892a2ddb5a8cf1e04b161f2742e976efee6a8b613f3d666aa8474a96 + codeSamplesRevisionDigest: sha256:8e0314e5a845c160c8a240517627432ecc1b8632dc1419aa32f03c2d868c969a workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/docs/models/annotation.md b/docs/models/annotation.md index 07491cc..0af955b 100644 --- a/docs/models/annotation.md +++ b/docs/models/annotation.md @@ -1,5 +1,7 @@ # Annotation +A URL citation when using web search. + ## Example Usage ```typescript @@ -21,5 +23,5 @@ let value: Annotation = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `type` | *"url_citation"* | :heavy_check_mark: | N/A | -| `urlCitation` | [models.AnnotationURLCitation](../models/annotationurlcitation.md) | :heavy_check_mark: | N/A | +| `urlCitation` | [models.AnnotationURLCitation](../models/annotationurlcitation.md) | :heavy_check_mark: | A URL citation when using web search. | | `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/annotationurlcitation.md b/docs/models/annotationurlcitation.md index 30c80ed..ac71e3d 100644 --- a/docs/models/annotationurlcitation.md +++ b/docs/models/annotationurlcitation.md @@ -1,5 +1,7 @@ # AnnotationURLCitation +A URL citation when using web search. + ## Example Usage ```typescript diff --git a/docs/models/audio.md b/docs/models/audio.md index 465bfaa..cd68d57 100644 --- a/docs/models/audio.md +++ b/docs/models/audio.md @@ -1,5 +1,8 @@ # Audio +Data about a previous audio response from the model. +[Learn more](https://platform.openai.com/docs/guides/audio). + ## Example Usage ```typescript diff --git a/docs/models/appapipublicv2functioncallcallfunctionrequest.md b/docs/models/callfunctionrequest.md similarity index 99% rename from docs/models/appapipublicv2functioncallcallfunctionrequest.md rename to docs/models/callfunctionrequest.md index 01d2aa9..3e14b6a 100644 --- a/docs/models/appapipublicv2functioncallcallfunctionrequest.md +++ b/docs/models/callfunctionrequest.md @@ -1,11 +1,11 @@ -# AppApiPublicV2FunctionCallCallFunctionRequest +# CallFunctionRequest ## Example Usage ```typescript -import { AppApiPublicV2FunctionCallCallFunctionRequest } from "opperai/models"; +import { CallFunctionRequest } from "opperai/models"; -let value: AppApiPublicV2FunctionCallCallFunctionRequest = { +let value: CallFunctionRequest = { name: "add_numbers", instructions: "Calculate the sum of two numbers", inputSchema: { diff --git a/docs/models/appapipublicv2functioncallcallfunctionresponse.md b/docs/models/callfunctionresponse.md similarity index 98% rename from docs/models/appapipublicv2functioncallcallfunctionresponse.md rename to docs/models/callfunctionresponse.md index 6878c43..53bc878 100644 --- a/docs/models/appapipublicv2functioncallcallfunctionresponse.md +++ b/docs/models/callfunctionresponse.md @@ -1,12 +1,12 @@ -# AppApiPublicV2FunctionCallCallFunctionResponse +# CallFunctionResponse ## Example Usage ```typescript -import { AppApiPublicV2FunctionCallCallFunctionResponse } from "opperai/models"; +import { CallFunctionResponse } from "opperai/models"; -let value: AppApiPublicV2FunctionCallCallFunctionResponse = { - spanId: "fe8c2e6e-0531-4ec9-92e0-5633b8cd9b3a", +let value: CallFunctionResponse = { + spanId: "e9cdfdda-24c9-49c9-b80b-1a2728c3f909", message: "The sum of 1 and 3 is 4", jsonPayload: { "sum": 4, diff --git a/docs/models/chatcompletion.md b/docs/models/chatcompletion.md index ffe3c96..ebe5472 100644 --- a/docs/models/chatcompletion.md +++ b/docs/models/chatcompletion.md @@ -1,5 +1,7 @@ # ChatCompletion +Represents a chat completion response returned by model, based on the provided input. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionallowedtoolchoiceparam.md b/docs/models/chatcompletionallowedtoolchoiceparam.md index 5d91113..fa0507f 100644 --- a/docs/models/chatcompletionallowedtoolchoiceparam.md +++ b/docs/models/chatcompletionallowedtoolchoiceparam.md @@ -1,5 +1,7 @@ # ChatCompletionAllowedToolChoiceParam +Constrains the tools available to the model to a pre-defined set. + ## Example Usage ```typescript @@ -28,5 +30,5 @@ let value: ChatCompletionAllowedToolChoiceParam = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `allowedTools` | [models.ChatCompletionAllowedToolsParam](../models/chatcompletionallowedtoolsparam.md) | :heavy_check_mark: | N/A | +| `allowedTools` | [models.ChatCompletionAllowedToolsParam](../models/chatcompletionallowedtoolsparam.md) | :heavy_check_mark: | Constrains the tools available to the model to a pre-defined set. | | `type` | *"allowed_tools"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletionallowedtoolsparam.md b/docs/models/chatcompletionallowedtoolsparam.md index e1e8e62..e077949 100644 --- a/docs/models/chatcompletionallowedtoolsparam.md +++ b/docs/models/chatcompletionallowedtoolsparam.md @@ -1,5 +1,7 @@ # ChatCompletionAllowedToolsParam +Constrains the tools available to the model to a pre-defined set. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionassistantmessageparam.md b/docs/models/chatcompletionassistantmessageparam.md index 45f1715..91bec88 100644 --- a/docs/models/chatcompletionassistantmessageparam.md +++ b/docs/models/chatcompletionassistantmessageparam.md @@ -1,5 +1,7 @@ # ChatCompletionAssistantMessageParam +Messages sent by the model in response to user messages. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionaudio.md b/docs/models/chatcompletionaudio.md index dd83282..26cc7c5 100644 --- a/docs/models/chatcompletionaudio.md +++ b/docs/models/chatcompletionaudio.md @@ -1,5 +1,8 @@ # ChatCompletionAudio +If the audio output modality is requested, this object contains data +about the audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio). + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionaudioparam.md b/docs/models/chatcompletionaudioparam.md index 1162a5c..6a95ba2 100644 --- a/docs/models/chatcompletionaudioparam.md +++ b/docs/models/chatcompletionaudioparam.md @@ -1,5 +1,10 @@ # ChatCompletionAudioParam +Parameters for audio output. + +Required when audio output is requested with +`modalities: ["audio"]`. [Learn more](https://platform.openai.com/docs/guides/audio). + ## Example Usage ```typescript @@ -7,7 +12,7 @@ import { ChatCompletionAudioParam } from "opperai/models"; let value: ChatCompletionAudioParam = { format: "wav", - voice: "shimmer", + voice: "verse", }; ``` diff --git a/docs/models/chatcompletioncontentpartimageparam.md b/docs/models/chatcompletioncontentpartimageparam.md index 200eb33..f6e71b6 100644 --- a/docs/models/chatcompletioncontentpartimageparam.md +++ b/docs/models/chatcompletioncontentpartimageparam.md @@ -1,5 +1,7 @@ # ChatCompletionContentPartImageParam +Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + ## Example Usage ```typescript diff --git a/docs/models/chatcompletioncontentpartinputaudioparam.md b/docs/models/chatcompletioncontentpartinputaudioparam.md index ef4c72d..2ff225a 100644 --- a/docs/models/chatcompletioncontentpartinputaudioparam.md +++ b/docs/models/chatcompletioncontentpartinputaudioparam.md @@ -1,5 +1,7 @@ # ChatCompletionContentPartInputAudioParam +Learn about [audio inputs](https://platform.openai.com/docs/guides/audio). + ## Example Usage ```typescript diff --git a/docs/models/chatcompletioncontentparttextparam.md b/docs/models/chatcompletioncontentparttextparam.md index 28359d7..98455fa 100644 --- a/docs/models/chatcompletioncontentparttextparam.md +++ b/docs/models/chatcompletioncontentparttextparam.md @@ -1,5 +1,7 @@ # ChatCompletionContentPartTextParam +Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation). + ## Example Usage ```typescript diff --git a/docs/models/chatcompletioncustomtoolparam.md b/docs/models/chatcompletioncustomtoolparam.md index c3c1fa4..49d4e0b 100644 --- a/docs/models/chatcompletioncustomtoolparam.md +++ b/docs/models/chatcompletioncustomtoolparam.md @@ -1,5 +1,7 @@ # ChatCompletionCustomToolParam +A custom tool that processes input using a specified format. + ## Example Usage ```typescript @@ -17,5 +19,5 @@ let value: ChatCompletionCustomToolParam = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `custom` | [models.OpenaiTypesChatChatCompletionCustomToolParamCustom](../models/openaitypeschatchatcompletioncustomtoolparamcustom.md) | :heavy_check_mark: | N/A | +| `custom` | [models.OpenaiTypesChatChatCompletionCustomToolParamCustom](../models/openaitypeschatchatcompletioncustomtoolparamcustom.md) | :heavy_check_mark: | Properties of the custom tool. | | `type` | *"custom"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletiondevelopermessageparam.md b/docs/models/chatcompletiondevelopermessageparam.md index 068e222..ca1bb7b 100644 --- a/docs/models/chatcompletiondevelopermessageparam.md +++ b/docs/models/chatcompletiondevelopermessageparam.md @@ -1,5 +1,9 @@ # ChatCompletionDeveloperMessageParam +Developer-provided instructions that the model should follow, regardless of +messages sent by the user. With o1 models and newer, `developer` messages +replace the previous `system` messages. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionfunctioncalloptionparam.md b/docs/models/chatcompletionfunctioncalloptionparam.md index b49b38a..48b4c38 100644 --- a/docs/models/chatcompletionfunctioncalloptionparam.md +++ b/docs/models/chatcompletionfunctioncalloptionparam.md @@ -1,5 +1,7 @@ # ChatCompletionFunctionCallOptionParam +Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionfunctiontoolparam.md b/docs/models/chatcompletionfunctiontoolparam.md index ad9367c..99ebb70 100644 --- a/docs/models/chatcompletionfunctiontoolparam.md +++ b/docs/models/chatcompletionfunctiontoolparam.md @@ -1,5 +1,7 @@ # ChatCompletionFunctionToolParam +A function tool that can be used to generate a response. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionmessage.md b/docs/models/chatcompletionmessage.md index 6d214ef..79d855d 100644 --- a/docs/models/chatcompletionmessage.md +++ b/docs/models/chatcompletionmessage.md @@ -1,5 +1,7 @@ # ChatCompletionMessage +A chat completion message generated by the model. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionmessagecustomtoolcall.md b/docs/models/chatcompletionmessagecustomtoolcall.md index 0e819d2..4567ad8 100644 --- a/docs/models/chatcompletionmessagecustomtoolcall.md +++ b/docs/models/chatcompletionmessagecustomtoolcall.md @@ -1,5 +1,7 @@ # ChatCompletionMessageCustomToolCall +A call to a custom tool created by the model. + ## Example Usage ```typescript @@ -20,6 +22,6 @@ let value: ChatCompletionMessageCustomToolCall = { | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | N/A | -| `custom` | [models.CustomOutput](../models/customoutput.md) | :heavy_check_mark: | N/A | +| `custom` | [models.CustomOutput](../models/customoutput.md) | :heavy_check_mark: | The custom tool that the model called. | | `type` | *"custom"* | :heavy_check_mark: | N/A | | `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletionmessagecustomtoolcallparam.md b/docs/models/chatcompletionmessagecustomtoolcallparam.md index 32240fc..d7e3faa 100644 --- a/docs/models/chatcompletionmessagecustomtoolcallparam.md +++ b/docs/models/chatcompletionmessagecustomtoolcallparam.md @@ -1,5 +1,7 @@ # ChatCompletionMessageCustomToolCallParam +A call to a custom tool created by the model. + ## Example Usage ```typescript @@ -20,5 +22,5 @@ let value: ChatCompletionMessageCustomToolCallParam = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `custom` | [models.OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom](../models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md) | :heavy_check_mark: | N/A | +| `custom` | [models.OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom](../models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md) | :heavy_check_mark: | The custom tool that the model called. | | `type` | *"custom"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletionmessagefunctiontoolcall.md b/docs/models/chatcompletionmessagefunctiontoolcall.md index db81f23..8724358 100644 --- a/docs/models/chatcompletionmessagefunctiontoolcall.md +++ b/docs/models/chatcompletionmessagefunctiontoolcall.md @@ -1,5 +1,7 @@ # ChatCompletionMessageFunctionToolCall +A call to a function tool created by the model. + ## Example Usage ```typescript @@ -20,6 +22,6 @@ let value: ChatCompletionMessageFunctionToolCall = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `function` | [models.FunctionOutput](../models/functionoutput.md) | :heavy_check_mark: | N/A | +| `function` | [models.FunctionOutput](../models/functionoutput.md) | :heavy_check_mark: | The function that the model called. | | `type` | *"function"* | :heavy_check_mark: | N/A | | `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletionmessagefunctiontoolcallparam.md b/docs/models/chatcompletionmessagefunctiontoolcallparam.md index 5aa5019..e7b0777 100644 --- a/docs/models/chatcompletionmessagefunctiontoolcallparam.md +++ b/docs/models/chatcompletionmessagefunctiontoolcallparam.md @@ -1,5 +1,7 @@ # ChatCompletionMessageFunctionToolCallParam +A call to a function tool created by the model. + ## Example Usage ```typescript @@ -20,5 +22,5 @@ let value: ChatCompletionMessageFunctionToolCallParam = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *string* | :heavy_check_mark: | N/A | -| `function` | [models.OpenaiTypesChatChatCompletionMessageFunctionToolCallParamFunction](../models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.md) | :heavy_check_mark: | N/A | +| `function` | [models.OpenaiTypesChatChatCompletionMessageFunctionToolCallParamFunction](../models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.md) | :heavy_check_mark: | The function that the model called. | | `type` | *"function"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletionnamedtoolchoicecustomparam.md b/docs/models/chatcompletionnamedtoolchoicecustomparam.md index c3877ac..2c2d8ec 100644 --- a/docs/models/chatcompletionnamedtoolchoicecustomparam.md +++ b/docs/models/chatcompletionnamedtoolchoicecustomparam.md @@ -1,5 +1,9 @@ # ChatCompletionNamedToolChoiceCustomParam +Specifies a tool the model should use. + +Use to force the model to call a specific custom tool. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionnamedtoolchoiceparam.md b/docs/models/chatcompletionnamedtoolchoiceparam.md index d98357f..60c71ee 100644 --- a/docs/models/chatcompletionnamedtoolchoiceparam.md +++ b/docs/models/chatcompletionnamedtoolchoiceparam.md @@ -1,5 +1,9 @@ # ChatCompletionNamedToolChoiceParam +Specifies a tool the model should use. + +Use to force the model to call a specific function. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionnonstreaming.md b/docs/models/chatcompletionnonstreaming.md index f9909b6..db5a338 100644 --- a/docs/models/chatcompletionnonstreaming.md +++ b/docs/models/chatcompletionnonstreaming.md @@ -16,41 +16,42 @@ let value: ChatCompletionNonStreaming = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `messages` | *models.ChatCompletionNonStreamingMessage*[] | :heavy_check_mark: | N/A | -| `model` | *models.TModel* | :heavy_minus_sign: | N/A | -| `audio` | [models.ChatCompletionAudioParam](../models/chatcompletionaudioparam.md) | :heavy_minus_sign: | N/A | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | -| `functionCall` | *models.ChatCompletionNonStreamingFunctionCallUnion* | :heavy_minus_sign: | N/A | -| `functions` | [models.OpenaiTypesChatCompletionCreateParamsFunction](../models/openaitypeschatcompletioncreateparamsfunction.md)[] | :heavy_minus_sign: | N/A | -| `logitBias` | Record | :heavy_minus_sign: | N/A | -| `logprobs` | *boolean* | :heavy_minus_sign: | N/A | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | N/A | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | -| `metadata` | Record | :heavy_minus_sign: | N/A | -| `modalities` | [models.ChatCompletionNonStreamingModality](../models/chatcompletionnonstreamingmodality.md)[] | :heavy_minus_sign: | N/A | -| `n` | *number* | :heavy_minus_sign: | N/A | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | -| `prediction` | [models.ChatCompletionPredictionContentParam](../models/chatcompletionpredictioncontentparam.md) | :heavy_minus_sign: | N/A | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | -| `reasoningEffort` | [models.ChatCompletionNonStreamingReasoningEffort](../models/chatcompletionnonstreamingreasoningeffort.md) | :heavy_minus_sign: | N/A | -| `responseFormat` | *models.ChatCompletionNonStreamingResponseFormat* | :heavy_minus_sign: | N/A | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | -| `seed` | *number* | :heavy_minus_sign: | N/A | -| `serviceTier` | [models.ChatCompletionNonStreamingServiceTier](../models/chatcompletionnonstreamingservicetier.md) | :heavy_minus_sign: | N/A | -| `stop` | *models.ChatCompletionNonStreamingStop* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | N/A | -| `streamOptions` | [models.ChatCompletionStreamOptionsParam](../models/chatcompletionstreamoptionsparam.md) | :heavy_minus_sign: | N/A | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `toolChoice` | *models.ChatCompletionNonStreamingToolChoiceUnion* | :heavy_minus_sign: | N/A | -| `tools` | *models.ChatCompletionNonStreamingTool*[] | :heavy_minus_sign: | N/A | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | -| `user` | *string* | :heavy_minus_sign: | N/A | -| `verbosity` | [models.ChatCompletionNonStreamingVerbosity](../models/chatcompletionnonstreamingverbosity.md) | :heavy_minus_sign: | N/A | -| `webSearchOptions` | [models.WebSearchOptions](../models/websearchoptions.md) | :heavy_minus_sign: | N/A | -| `stream` | *false* | :heavy_minus_sign: | N/A | -| `tags` | Record | :heavy_minus_sign: | N/A | -| `parentSpanId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `messages` | *models.ChatCompletionNonStreamingMessage*[] | :heavy_check_mark: | N/A | +| `model` | *models.TModel* | :heavy_minus_sign: | N/A | +| `audio` | [models.ChatCompletionAudioParam](../models/chatcompletionaudioparam.md) | :heavy_minus_sign: | N/A | +| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | +| `functionCall` | *models.ChatCompletionNonStreamingFunctionCallUnion* | :heavy_minus_sign: | N/A | +| `functions` | [models.OpenaiTypesChatCompletionCreateParamsFunction](../models/openaitypeschatcompletioncreateparamsfunction.md)[] | :heavy_minus_sign: | N/A | +| `logitBias` | Record | :heavy_minus_sign: | N/A | +| `logprobs` | *boolean* | :heavy_minus_sign: | N/A | +| `maxCompletionTokens` | *number* | :heavy_minus_sign: | N/A | +| `maxTokens` | *number* | :heavy_minus_sign: | N/A | +| `metadata` | Record | :heavy_minus_sign: | N/A | +| `modalities` | [models.ChatCompletionNonStreamingModality](../models/chatcompletionnonstreamingmodality.md)[] | :heavy_minus_sign: | N/A | +| `n` | *number* | :heavy_minus_sign: | N/A | +| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | +| `prediction` | [models.ChatCompletionPredictionContentParam](../models/chatcompletionpredictioncontentparam.md) | :heavy_minus_sign: | N/A | +| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | +| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | +| `promptCacheRetention` | [models.ChatCompletionNonStreamingPromptCacheRetention](../models/chatcompletionnonstreamingpromptcacheretention.md) | :heavy_minus_sign: | N/A | +| `reasoningEffort` | [models.ChatCompletionNonStreamingReasoningEffort](../models/chatcompletionnonstreamingreasoningeffort.md) | :heavy_minus_sign: | N/A | +| `responseFormat` | *models.ChatCompletionNonStreamingResponseFormat* | :heavy_minus_sign: | N/A | +| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | +| `seed` | *number* | :heavy_minus_sign: | N/A | +| `serviceTier` | [models.ChatCompletionNonStreamingServiceTier](../models/chatcompletionnonstreamingservicetier.md) | :heavy_minus_sign: | N/A | +| `stop` | *models.ChatCompletionNonStreamingStop* | :heavy_minus_sign: | N/A | +| `store` | *boolean* | :heavy_minus_sign: | N/A | +| `streamOptions` | [models.ChatCompletionStreamOptionsParam](../models/chatcompletionstreamoptionsparam.md) | :heavy_minus_sign: | N/A | +| `temperature` | *number* | :heavy_minus_sign: | N/A | +| `toolChoice` | *models.ChatCompletionNonStreamingToolChoiceUnion* | :heavy_minus_sign: | N/A | +| `tools` | *models.ChatCompletionNonStreamingTool*[] | :heavy_minus_sign: | N/A | +| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | +| `topP` | *number* | :heavy_minus_sign: | N/A | +| `user` | *string* | :heavy_minus_sign: | N/A | +| `verbosity` | [models.ChatCompletionNonStreamingVerbosity](../models/chatcompletionnonstreamingverbosity.md) | :heavy_minus_sign: | N/A | +| `webSearchOptions` | [models.WebSearchOptions](../models/websearchoptions.md) | :heavy_minus_sign: | This tool searches the web for relevant results to use in a response.
Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). | +| `stream` | *false* | :heavy_minus_sign: | N/A | +| `tags` | Record | :heavy_minus_sign: | N/A | +| `parentSpanId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletionnonstreamingpromptcacheretention.md b/docs/models/chatcompletionnonstreamingpromptcacheretention.md new file mode 100644 index 0000000..2682e29 --- /dev/null +++ b/docs/models/chatcompletionnonstreamingpromptcacheretention.md @@ -0,0 +1,15 @@ +# ChatCompletionNonStreamingPromptCacheRetention + +## Example Usage + +```typescript +import { ChatCompletionNonStreamingPromptCacheRetention } from "opperai/models"; + +let value: ChatCompletionNonStreamingPromptCacheRetention = "24h"; +``` + +## Values + +```typescript +"in-memory" | "24h" +``` \ No newline at end of file diff --git a/docs/models/chatcompletionnonstreamingreasoningeffort.md b/docs/models/chatcompletionnonstreamingreasoningeffort.md index 96506ba..f6ab9cf 100644 --- a/docs/models/chatcompletionnonstreamingreasoningeffort.md +++ b/docs/models/chatcompletionnonstreamingreasoningeffort.md @@ -5,11 +5,11 @@ ```typescript import { ChatCompletionNonStreamingReasoningEffort } from "opperai/models"; -let value: ChatCompletionNonStreamingReasoningEffort = "high"; +let value: ChatCompletionNonStreamingReasoningEffort = "xhigh"; ``` ## Values ```typescript -"minimal" | "low" | "medium" | "high" +"none" | "minimal" | "low" | "medium" | "high" | "xhigh" ``` \ No newline at end of file diff --git a/docs/models/chatcompletionpredictioncontentparam.md b/docs/models/chatcompletionpredictioncontentparam.md index 3ff3198..f4ec398 100644 --- a/docs/models/chatcompletionpredictioncontentparam.md +++ b/docs/models/chatcompletionpredictioncontentparam.md @@ -1,5 +1,8 @@ # ChatCompletionPredictionContentParam +Static predicted output content, such as the content of a text file that is +being regenerated. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionstreaming.md b/docs/models/chatcompletionstreaming.md index 0227faf..8878f63 100644 --- a/docs/models/chatcompletionstreaming.md +++ b/docs/models/chatcompletionstreaming.md @@ -18,41 +18,42 @@ let value: ChatCompletionStreaming = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `messages` | *models.ChatCompletionStreamingMessage*[] | :heavy_check_mark: | N/A | -| `model` | *models.TModel* | :heavy_minus_sign: | N/A | -| `audio` | [models.ChatCompletionAudioParam](../models/chatcompletionaudioparam.md) | :heavy_minus_sign: | N/A | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | -| `functionCall` | *models.ChatCompletionStreamingFunctionCallUnion* | :heavy_minus_sign: | N/A | -| `functions` | [models.OpenaiTypesChatCompletionCreateParamsFunction](../models/openaitypeschatcompletioncreateparamsfunction.md)[] | :heavy_minus_sign: | N/A | -| `logitBias` | Record | :heavy_minus_sign: | N/A | -| `logprobs` | *boolean* | :heavy_minus_sign: | N/A | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | N/A | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | -| `metadata` | Record | :heavy_minus_sign: | N/A | -| `modalities` | [models.ChatCompletionStreamingModality](../models/chatcompletionstreamingmodality.md)[] | :heavy_minus_sign: | N/A | -| `n` | *number* | :heavy_minus_sign: | N/A | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | -| `prediction` | [models.ChatCompletionPredictionContentParam](../models/chatcompletionpredictioncontentparam.md) | :heavy_minus_sign: | N/A | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | -| `reasoningEffort` | [models.ChatCompletionStreamingReasoningEffort](../models/chatcompletionstreamingreasoningeffort.md) | :heavy_minus_sign: | N/A | -| `responseFormat` | *models.ChatCompletionStreamingResponseFormat* | :heavy_minus_sign: | N/A | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | -| `seed` | *number* | :heavy_minus_sign: | N/A | -| `serviceTier` | [models.ChatCompletionStreamingServiceTier](../models/chatcompletionstreamingservicetier.md) | :heavy_minus_sign: | N/A | -| `stop` | *models.ChatCompletionStreamingStop* | :heavy_minus_sign: | N/A | -| `store` | *boolean* | :heavy_minus_sign: | N/A | -| `streamOptions` | [models.ChatCompletionStreamOptionsParam](../models/chatcompletionstreamoptionsparam.md) | :heavy_minus_sign: | N/A | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `toolChoice` | *models.ChatCompletionStreamingToolChoiceUnion* | :heavy_minus_sign: | N/A | -| `tools` | *models.ChatCompletionStreamingTool*[] | :heavy_minus_sign: | N/A | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | -| `user` | *string* | :heavy_minus_sign: | N/A | -| `verbosity` | [models.ChatCompletionStreamingVerbosity](../models/chatcompletionstreamingverbosity.md) | :heavy_minus_sign: | N/A | -| `webSearchOptions` | [models.WebSearchOptions](../models/websearchoptions.md) | :heavy_minus_sign: | N/A | -| `stream` | *true* | :heavy_check_mark: | N/A | -| `tags` | Record | :heavy_minus_sign: | N/A | -| `parentSpanId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `messages` | *models.ChatCompletionStreamingMessage*[] | :heavy_check_mark: | N/A | +| `model` | *models.TModel* | :heavy_minus_sign: | N/A | +| `audio` | [models.ChatCompletionAudioParam](../models/chatcompletionaudioparam.md) | :heavy_minus_sign: | N/A | +| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | +| `functionCall` | *models.ChatCompletionStreamingFunctionCallUnion* | :heavy_minus_sign: | N/A | +| `functions` | [models.OpenaiTypesChatCompletionCreateParamsFunction](../models/openaitypeschatcompletioncreateparamsfunction.md)[] | :heavy_minus_sign: | N/A | +| `logitBias` | Record | :heavy_minus_sign: | N/A | +| `logprobs` | *boolean* | :heavy_minus_sign: | N/A | +| `maxCompletionTokens` | *number* | :heavy_minus_sign: | N/A | +| `maxTokens` | *number* | :heavy_minus_sign: | N/A | +| `metadata` | Record | :heavy_minus_sign: | N/A | +| `modalities` | [models.ChatCompletionStreamingModality](../models/chatcompletionstreamingmodality.md)[] | :heavy_minus_sign: | N/A | +| `n` | *number* | :heavy_minus_sign: | N/A | +| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | +| `prediction` | [models.ChatCompletionPredictionContentParam](../models/chatcompletionpredictioncontentparam.md) | :heavy_minus_sign: | N/A | +| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | +| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | +| `promptCacheRetention` | [models.ChatCompletionStreamingPromptCacheRetention](../models/chatcompletionstreamingpromptcacheretention.md) | :heavy_minus_sign: | N/A | +| `reasoningEffort` | [models.ChatCompletionStreamingReasoningEffort](../models/chatcompletionstreamingreasoningeffort.md) | :heavy_minus_sign: | N/A | +| `responseFormat` | *models.ChatCompletionStreamingResponseFormat* | :heavy_minus_sign: | N/A | +| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | +| `seed` | *number* | :heavy_minus_sign: | N/A | +| `serviceTier` | [models.ChatCompletionStreamingServiceTier](../models/chatcompletionstreamingservicetier.md) | :heavy_minus_sign: | N/A | +| `stop` | *models.ChatCompletionStreamingStop* | :heavy_minus_sign: | N/A | +| `store` | *boolean* | :heavy_minus_sign: | N/A | +| `streamOptions` | [models.ChatCompletionStreamOptionsParam](../models/chatcompletionstreamoptionsparam.md) | :heavy_minus_sign: | N/A | +| `temperature` | *number* | :heavy_minus_sign: | N/A | +| `toolChoice` | *models.ChatCompletionStreamingToolChoiceUnion* | :heavy_minus_sign: | N/A | +| `tools` | *models.ChatCompletionStreamingTool*[] | :heavy_minus_sign: | N/A | +| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | +| `topP` | *number* | :heavy_minus_sign: | N/A | +| `user` | *string* | :heavy_minus_sign: | N/A | +| `verbosity` | [models.ChatCompletionStreamingVerbosity](../models/chatcompletionstreamingverbosity.md) | :heavy_minus_sign: | N/A | +| `webSearchOptions` | [models.WebSearchOptions](../models/websearchoptions.md) | :heavy_minus_sign: | This tool searches the web for relevant results to use in a response.
Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). | +| `stream` | *true* | :heavy_check_mark: | N/A | +| `tags` | Record | :heavy_minus_sign: | N/A | +| `parentSpanId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/chatcompletionstreamingpromptcacheretention.md b/docs/models/chatcompletionstreamingpromptcacheretention.md new file mode 100644 index 0000000..985f6b0 --- /dev/null +++ b/docs/models/chatcompletionstreamingpromptcacheretention.md @@ -0,0 +1,15 @@ +# ChatCompletionStreamingPromptCacheRetention + +## Example Usage + +```typescript +import { ChatCompletionStreamingPromptCacheRetention } from "opperai/models"; + +let value: ChatCompletionStreamingPromptCacheRetention = "24h"; +``` + +## Values + +```typescript +"in-memory" | "24h" +``` \ No newline at end of file diff --git a/docs/models/chatcompletionstreamingreasoningeffort.md b/docs/models/chatcompletionstreamingreasoningeffort.md index d913d8b..21e663a 100644 --- a/docs/models/chatcompletionstreamingreasoningeffort.md +++ b/docs/models/chatcompletionstreamingreasoningeffort.md @@ -11,5 +11,5 @@ let value: ChatCompletionStreamingReasoningEffort = "low"; ## Values ```typescript -"minimal" | "low" | "medium" | "high" +"none" | "minimal" | "low" | "medium" | "high" | "xhigh" ``` \ No newline at end of file diff --git a/docs/models/chatcompletionstreamoptionsparam.md b/docs/models/chatcompletionstreamoptionsparam.md index 38ccec4..ba375a6 100644 --- a/docs/models/chatcompletionstreamoptionsparam.md +++ b/docs/models/chatcompletionstreamoptionsparam.md @@ -1,5 +1,7 @@ # ChatCompletionStreamOptionsParam +Options for streaming response. Only set this when you set `stream: true`. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionsystemmessageparam.md b/docs/models/chatcompletionsystemmessageparam.md index d0e43a1..05ca2e4 100644 --- a/docs/models/chatcompletionsystemmessageparam.md +++ b/docs/models/chatcompletionsystemmessageparam.md @@ -1,5 +1,9 @@ # ChatCompletionSystemMessageParam +Developer-provided instructions that the model should follow, regardless of +messages sent by the user. With o1 models and newer, use `developer` messages +for this purpose instead. + ## Example Usage ```typescript diff --git a/docs/models/chatcompletionusermessageparam.md b/docs/models/chatcompletionusermessageparam.md index cd77728..28f7aae 100644 --- a/docs/models/chatcompletionusermessageparam.md +++ b/docs/models/chatcompletionusermessageparam.md @@ -1,5 +1,8 @@ # ChatCompletionUserMessageParam +Messages sent by an end user, containing prompts or additional context +information. + ## Example Usage ```typescript diff --git a/docs/models/choice.md b/docs/models/choice.md index 8c3f0c5..1f66881 100644 --- a/docs/models/choice.md +++ b/docs/models/choice.md @@ -21,5 +21,5 @@ let value: Choice = { | `finishReason` | [models.FinishReason](../models/finishreason.md) | :heavy_check_mark: | N/A | | `index` | *number* | :heavy_check_mark: | N/A | | `logprobs` | [models.ChoiceLogprobs](../models/choicelogprobs.md) | :heavy_minus_sign: | N/A | -| `message` | [models.ChatCompletionMessage](../models/chatcompletionmessage.md) | :heavy_check_mark: | N/A | +| `message` | [models.ChatCompletionMessage](../models/chatcompletionmessage.md) | :heavy_check_mark: | A chat completion message generated by the model. | | `additionalProperties` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/choicelogprobs.md b/docs/models/choicelogprobs.md index 311d9d7..ebb611d 100644 --- a/docs/models/choicelogprobs.md +++ b/docs/models/choicelogprobs.md @@ -1,5 +1,7 @@ # ChoiceLogprobs +Log probability information for the choice. + ## Example Usage ```typescript diff --git a/docs/models/completiontokensdetails.md b/docs/models/completiontokensdetails.md index da95ad7..dc48c65 100644 --- a/docs/models/completiontokensdetails.md +++ b/docs/models/completiontokensdetails.md @@ -1,5 +1,7 @@ # CompletionTokensDetails +Breakdown of tokens used in a completion. + ## Example Usage ```typescript diff --git a/docs/models/completionusage.md b/docs/models/completionusage.md index 32e14a4..1d43457 100644 --- a/docs/models/completionusage.md +++ b/docs/models/completionusage.md @@ -1,5 +1,7 @@ # CompletionUsage +Usage statistics for the completion request. + ## Example Usage ```typescript diff --git a/docs/models/customformatgrammar.md b/docs/models/customformatgrammar.md index 16dfeff..1ca0670 100644 --- a/docs/models/customformatgrammar.md +++ b/docs/models/customformatgrammar.md @@ -1,5 +1,7 @@ # CustomFormatGrammar +A grammar defined by the user. + ## Example Usage ```typescript @@ -18,5 +20,5 @@ let value: CustomFormatGrammar = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `grammar` | [models.CustomFormatGrammarGrammar](../models/customformatgrammargrammar.md) | :heavy_check_mark: | N/A | +| `grammar` | [models.CustomFormatGrammarGrammar](../models/customformatgrammargrammar.md) | :heavy_check_mark: | Your chosen grammar. | | `type` | *"grammar"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/customformatgrammargrammar.md b/docs/models/customformatgrammargrammar.md index cfe38aa..8a1d5fe 100644 --- a/docs/models/customformatgrammargrammar.md +++ b/docs/models/customformatgrammargrammar.md @@ -1,5 +1,7 @@ # CustomFormatGrammarGrammar +Your chosen grammar. + ## Example Usage ```typescript diff --git a/docs/models/customformattext.md b/docs/models/customformattext.md index f9b592b..31439ae 100644 --- a/docs/models/customformattext.md +++ b/docs/models/customformattext.md @@ -1,5 +1,7 @@ # CustomFormatText +Unconstrained free-form text. + ## Example Usage ```typescript diff --git a/docs/models/customoutput.md b/docs/models/customoutput.md index 461bcbe..eaa25b7 100644 --- a/docs/models/customoutput.md +++ b/docs/models/customoutput.md @@ -1,5 +1,7 @@ # CustomOutput +The custom tool that the model called. + ## Example Usage ```typescript diff --git a/docs/models/filet.md b/docs/models/filet.md index 4cbe3e4..ae92489 100644 --- a/docs/models/filet.md +++ b/docs/models/filet.md @@ -1,5 +1,7 @@ # FileT +Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation. + ## Example Usage ```typescript diff --git a/docs/models/functioncallinput.md b/docs/models/functioncallinput.md index bc0c33f..8b3e9f1 100644 --- a/docs/models/functioncallinput.md +++ b/docs/models/functioncallinput.md @@ -1,5 +1,9 @@ # FunctionCallInput +Deprecated and replaced by `tool_calls`. + +The name and arguments of a function that should be called, as generated by the model. + ## Example Usage ```typescript diff --git a/docs/models/functioncalloutput.md b/docs/models/functioncalloutput.md index 5ca4368..3afb3b4 100644 --- a/docs/models/functioncalloutput.md +++ b/docs/models/functioncalloutput.md @@ -1,5 +1,9 @@ # FunctionCallOutput +Deprecated and replaced by `tool_calls`. + +The name and arguments of a function that should be called, as generated by the model. + ## Example Usage ```typescript diff --git a/docs/models/functionoutput.md b/docs/models/functionoutput.md index 4ecdedb..73e1332 100644 --- a/docs/models/functionoutput.md +++ b/docs/models/functionoutput.md @@ -1,5 +1,7 @@ # FunctionOutput +The function that the model called. + ## Example Usage ```typescript diff --git a/docs/models/input.md b/docs/models/input.md index c732644..c5b0cb4 100644 --- a/docs/models/input.md +++ b/docs/models/input.md @@ -16,6 +16,7 @@ const value: string = "Hello, world!"; ```typescript const value: string[] = [ "Hello, world!", + "Hello, world!", ]; ``` diff --git a/docs/models/jsonpayload.md b/docs/models/jsonpayload.md index 88bb7e7..bf534e1 100644 --- a/docs/models/jsonpayload.md +++ b/docs/models/jsonpayload.md @@ -17,9 +17,9 @@ const value: { [k: string]: any } = { ```typescript const value: any[] = [ - { - "sum": 4, - }, + "", + "", + "", ]; ``` diff --git a/docs/models/jsonschema.md b/docs/models/jsonschema.md index b4a1e57..fd1b60d 100644 --- a/docs/models/jsonschema.md +++ b/docs/models/jsonschema.md @@ -1,5 +1,7 @@ # JSONSchema +Structured Outputs configuration options, including a JSON Schema. + ## Example Usage ```typescript diff --git a/docs/models/openaitypeschatchatcompletioncustomtoolparamcustom.md b/docs/models/openaitypeschatchatcompletioncustomtoolparamcustom.md index bb0f890..4c0feaf 100644 --- a/docs/models/openaitypeschatchatcompletioncustomtoolparamcustom.md +++ b/docs/models/openaitypeschatchatcompletioncustomtoolparamcustom.md @@ -1,5 +1,7 @@ # OpenaiTypesChatChatCompletionCustomToolParamCustom +Properties of the custom tool. + ## Example Usage ```typescript diff --git a/docs/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md b/docs/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md index b8326b4..553c612 100644 --- a/docs/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md +++ b/docs/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md @@ -1,5 +1,7 @@ # OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom +The custom tool that the model called. + ## Example Usage ```typescript diff --git a/docs/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.md b/docs/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.md index 0f16b4b..4756210 100644 --- a/docs/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.md +++ b/docs/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.md @@ -1,5 +1,7 @@ # OpenaiTypesChatChatCompletionMessageFunctionToolCallParamFunction +The function that the model called. + ## Example Usage ```typescript diff --git a/docs/models/operations/delta.md b/docs/models/operations/delta.md index c60cf6c..b7352e2 100644 --- a/docs/models/operations/delta.md +++ b/docs/models/operations/delta.md @@ -14,13 +14,13 @@ const value: string = "Hello"; ### `number` ```typescript -const value: number = NaN; +const value: number = 42; ``` ### `number` ```typescript -const value: number = NaN; +const value: number = 42; ``` ### `boolean` diff --git a/docs/models/operations/updatespanspansspanidpatchrequest.md b/docs/models/operations/updatespanspansspanidpatchrequest.md index 0da6d5c..3f5acf1 100644 --- a/docs/models/operations/updatespanspansspanidpatchrequest.md +++ b/docs/models/operations/updatespanspansspanidpatchrequest.md @@ -9,9 +9,9 @@ let value: UpdateSpanSpansSpanIdPatchRequest = { spanId: "c4686ca8-5f9f-483e-8cc2-e12731bcf9e5", updateSpanRequest: { name: "my span", - startTime: new Date("2026-01-02T11:36:47.278310Z"), + startTime: new Date("2026-02-02T03:09:03.441704Z"), type: "email_tool", - endTime: new Date("2026-01-02T11:36:47.278372Z"), + endTime: new Date("2026-02-02T03:09:03.441764Z"), input: "Hello, world!", output: "Hello, world!", error: "Exception: This is an error message", diff --git a/docs/models/prompttokensdetails.md b/docs/models/prompttokensdetails.md index cefdd05..723d0fb 100644 --- a/docs/models/prompttokensdetails.md +++ b/docs/models/prompttokensdetails.md @@ -1,5 +1,7 @@ # PromptTokensDetails +Breakdown of tokens used in the prompt. + ## Example Usage ```typescript diff --git a/docs/models/responseformatjsonobject.md b/docs/models/responseformatjsonobject.md index dfc925f..eb1624a 100644 --- a/docs/models/responseformatjsonobject.md +++ b/docs/models/responseformatjsonobject.md @@ -1,5 +1,12 @@ # ResponseFormatJSONObject +JSON object response format. + +An older method of generating JSON responses. +Using `json_schema` is recommended for models that support it. Note that the +model will not generate JSON without a system or user message instructing it +to do so. + ## Example Usage ```typescript diff --git a/docs/models/responseformatjsonschema.md b/docs/models/responseformatjsonschema.md index 3665d7f..5499077 100644 --- a/docs/models/responseformatjsonschema.md +++ b/docs/models/responseformatjsonschema.md @@ -1,5 +1,10 @@ # ResponseFormatJSONSchema +JSON Schema response format. + +Used to generate structured JSON responses. +Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + ## Example Usage ```typescript @@ -15,7 +20,7 @@ let value: ResponseFormatJSONSchema = { ## Fields -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `jsonSchema` | [models.JSONSchema](../models/jsonschema.md) | :heavy_check_mark: | N/A | -| `type` | *"json_schema"* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `jsonSchema` | [models.JSONSchema](../models/jsonschema.md) | :heavy_check_mark: | Structured Outputs configuration options, including a JSON Schema. | +| `type` | *"json_schema"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/responseformattext.md b/docs/models/responseformattext.md index 2d35bbb..bdcc515 100644 --- a/docs/models/responseformattext.md +++ b/docs/models/responseformattext.md @@ -1,5 +1,7 @@ # ResponseFormatText +Default response format. Used to generate text responses. + ## Example Usage ```typescript diff --git a/docs/models/updatespanrequest.md b/docs/models/updatespanrequest.md index f2a8f24..b93fd9b 100644 --- a/docs/models/updatespanrequest.md +++ b/docs/models/updatespanrequest.md @@ -7,9 +7,9 @@ import { UpdateSpanRequest } from "opperai/models"; let value: UpdateSpanRequest = { name: "my span", - startTime: new Date("2026-01-02T11:36:47.278310Z"), + startTime: new Date("2026-02-02T03:09:03.441704Z"), type: "email_tool", - endTime: new Date("2026-01-02T11:36:47.278372Z"), + endTime: new Date("2026-02-02T03:09:03.441764Z"), input: "Hello, world!", output: "Hello, world!", error: "Exception: This is an error message", @@ -25,9 +25,9 @@ let value: UpdateSpanRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | `name` | *string* | :heavy_minus_sign: | The name of the span, something descriptive about the span that will be used to identify it when querying | my span | -| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start time of the span in UTC | 2026-01-02T11:36:47.278310Z | +| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The start time of the span in UTC | 2026-02-02T03:09:03.441704Z | | `type` | *string* | :heavy_minus_sign: | The type of the span | email_tool | -| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end time of the span in UTC | 2026-01-02T11:36:47.278372Z | +| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The end time of the span in UTC | 2026-02-02T03:09:03.441764Z | | `input` | *string* | :heavy_minus_sign: | The input of the span | Hello, world! | | `output` | *string* | :heavy_minus_sign: | The output of the span | Hello, world! | | `error` | *string* | :heavy_minus_sign: | In case of an error, the error message | Exception: This is an error message | diff --git a/docs/models/value2.md b/docs/models/value2.md index 5922b98..21c866c 100644 --- a/docs/models/value2.md +++ b/docs/models/value2.md @@ -14,20 +14,18 @@ const value: string = "product"; ### `number` ```typescript -const value: number = NaN; +const value: number = 128403; ``` ### `number` ```typescript -const value: number = NaN; +const value: number = 1284.03; ``` ### `models.Value1[]` ```typescript -const value: models.Value1[] = [ - "product", -]; +const value: models.Value1[] = []; ``` diff --git a/docs/models/voice.md b/docs/models/voice.md index c984de7..3432a25 100644 --- a/docs/models/voice.md +++ b/docs/models/voice.md @@ -12,6 +12,6 @@ const value: string = ""; ### `models.VoiceEnum` ```typescript -const value: models.VoiceEnum = "shimmer"; +const value: models.VoiceEnum = "marin"; ``` diff --git a/docs/models/voiceenum.md b/docs/models/voiceenum.md index 4d65af2..94bca16 100644 --- a/docs/models/voiceenum.md +++ b/docs/models/voiceenum.md @@ -5,11 +5,11 @@ ```typescript import { VoiceEnum } from "opperai/models"; -let value: VoiceEnum = "echo"; +let value: VoiceEnum = "sage"; ``` ## Values ```typescript -"alloy" | "ash" | "ballad" | "coral" | "echo" | "sage" | "shimmer" | "verse" +"alloy" | "ash" | "ballad" | "coral" | "echo" | "sage" | "shimmer" | "verse" | "marin" | "cedar" ``` \ No newline at end of file diff --git a/docs/models/websearchoptions.md b/docs/models/websearchoptions.md index a1af0ed..8a2d5e3 100644 --- a/docs/models/websearchoptions.md +++ b/docs/models/websearchoptions.md @@ -1,5 +1,8 @@ # WebSearchOptions +This tool searches the web for relevant results to use in a response. +Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). + ## Example Usage ```typescript diff --git a/docs/models/websearchoptionsuserlocation.md b/docs/models/websearchoptionsuserlocation.md index 3839aa9..5d6c03c 100644 --- a/docs/models/websearchoptionsuserlocation.md +++ b/docs/models/websearchoptionsuserlocation.md @@ -1,5 +1,7 @@ # WebSearchOptionsUserLocation +Approximate location parameters for the search. + ## Example Usage ```typescript @@ -15,5 +17,5 @@ let value: WebSearchOptionsUserLocation = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `approximate` | [models.WebSearchOptionsUserLocationApproximate](../models/websearchoptionsuserlocationapproximate.md) | :heavy_check_mark: | N/A | +| `approximate` | [models.WebSearchOptionsUserLocationApproximate](../models/websearchoptionsuserlocationapproximate.md) | :heavy_check_mark: | Approximate location parameters for the search. | | `type` | *"approximate"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/websearchoptionsuserlocationapproximate.md b/docs/models/websearchoptionsuserlocationapproximate.md index 2daeee0..5d8ac85 100644 --- a/docs/models/websearchoptionsuserlocationapproximate.md +++ b/docs/models/websearchoptionsuserlocationapproximate.md @@ -1,5 +1,7 @@ # WebSearchOptionsUserLocationApproximate +Approximate location parameters for the search. + ## Example Usage ```typescript diff --git a/examples/package-lock.json b/examples/package-lock.json index 044e782..a734c98 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,9 +18,9 @@ }, "..": { "name": "opperai", - "version": "3.4.1", + "version": "3.4.2", "dependencies": { - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/sdk": "^1.25.2", "zod": "^3.25.0 || ^4.0.0" }, "bin": { diff --git a/jsr.json b/jsr.json index 029e1ab..09e1d27 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "opperai", - "version": "3.4.1", + "version": "3.4.2", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index d0b969c..66ec872 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,14 +1,14 @@ { "name": "opperai", - "version": "3.4.1", + "version": "3.4.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "opperai", - "version": "3.4.1", + "version": "3.4.2", "dependencies": { - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/sdk": "^1.25.2", "zod": "^3.25.0 || ^4.0.0" }, "bin": { @@ -183,9 +183,9 @@ } }, "node_modules/@hono/node-server": { - "version": "1.19.7", - "resolved": "https://registry.npmjs.org/@hono/node-server/-/node-server-1.19.7.tgz", - "integrity": "sha512-vUcD0uauS7EU2caukW8z5lJKtoGMokxNbJtBiwHgpqxEXokaHCBkQUmCHhjFB1VUTWdqj25QoMkMKzgjq+uhrw==", + "version": "1.19.9", + "resolved": "https://registry.npmjs.org/@hono/node-server/-/node-server-1.19.9.tgz", + "integrity": "sha512-vHL6w3ecZsky+8P5MD+eFfaGTyCeOHUIFYMGpQGbrBTSmNNoxv0if69rEZ5giu36weC5saFuznL411gRX7bJDw==", "license": "MIT", "engines": { "node": ">=18.14.1" @@ -279,12 +279,12 @@ } }, "node_modules/@modelcontextprotocol/sdk": { - "version": "1.25.1", - "resolved": "https://registry.npmjs.org/@modelcontextprotocol/sdk/-/sdk-1.25.1.tgz", - "integrity": "sha512-yO28oVFFC7EBoiKdAn+VqRm+plcfv4v0xp6osG/VsCB0NlPZWi87ajbCZZ8f/RvOFLEu7//rSRmuZZ7lMoe3gQ==", + "version": "1.25.3", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/sdk/-/sdk-1.25.3.tgz", + "integrity": "sha512-vsAMBMERybvYgKbg/l4L1rhS7VXV1c0CtyJg72vwxONVX0l4ZfKVAnZEWTQixJGTzKnELjQ59e4NbdFDALRiAQ==", "license": "MIT", "dependencies": { - "@hono/node-server": "^1.19.7", + "@hono/node-server": "^1.19.9", "ajv": "^8.17.1", "ajv-formats": "^3.0.1", "content-type": "^1.0.5", @@ -2454,9 +2454,9 @@ } }, "node_modules/hono": { - "version": "4.11.3", - "resolved": "https://registry.npmjs.org/hono/-/hono-4.11.3.tgz", - "integrity": "sha512-PmQi306+M/ct/m5s66Hrg+adPnkD5jiO6IjA7WhWw0gSBSo1EcRegwuI1deZ+wd5pzCGynCcn2DprnE4/yEV4w==", + "version": "4.11.7", + "resolved": "https://registry.npmjs.org/hono/-/hono-4.11.7.tgz", + "integrity": "sha512-l7qMiNee7t82bH3SeyUCt9UF15EVmaBvsppY2zQtrbIhl/yzBTny+YUxsVjSjQ6gaqaeVtZmGocom8TzBlA4Yw==", "license": "MIT", "peer": true, "engines": { diff --git a/package.json b/package.json index dbe4d67..29d5c2a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "opperai", - "version": "3.4.1", + "version": "3.4.2", "author": "Speakeasy", "repository": { "type": "git", @@ -47,7 +47,7 @@ "typescript-eslint": "^8.26.0" }, "dependencies": { - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/sdk": "^1.25.2", "zod": "^3.25.0 || ^4.0.0" }, "exports": { diff --git a/src/funcs/call.ts b/src/funcs/call.ts index 068898d..9489935 100644 --- a/src/funcs/call.ts +++ b/src/funcs/call.ts @@ -34,11 +34,11 @@ import { Result } from "../types/fp.js"; */ export function call( client: OpperCore, - request: models.AppApiPublicV2FunctionCallCallFunctionRequest, + request: models.CallFunctionRequest, options?: RequestOptions, ): APIPromise< Result< - models.AppApiPublicV2FunctionCallCallFunctionResponse, + models.CallFunctionResponse, | errors.BadRequestError | errors.UnauthorizedError | errors.NotFoundError @@ -62,12 +62,12 @@ export function call( async function $do( client: OpperCore, - request: models.AppApiPublicV2FunctionCallCallFunctionRequest, + request: models.CallFunctionRequest, options?: RequestOptions, ): Promise< [ Result< - models.AppApiPublicV2FunctionCallCallFunctionResponse, + models.CallFunctionResponse, | errors.BadRequestError | errors.UnauthorizedError | errors.NotFoundError @@ -86,10 +86,7 @@ async function $do( > { const parsed = safeParse( request, - (value) => - models.AppApiPublicV2FunctionCallCallFunctionRequest$outboundSchema.parse( - value, - ), + (value) => models.CallFunctionRequest$outboundSchema.parse(value), "Input validation failed", ); if (!parsed.ok) { @@ -155,7 +152,7 @@ async function $do( }; const [result] = await M.match< - models.AppApiPublicV2FunctionCallCallFunctionResponse, + models.CallFunctionResponse, | errors.BadRequestError | errors.UnauthorizedError | errors.NotFoundError @@ -169,10 +166,7 @@ async function $do( | UnexpectedClientError | SDKValidationError >( - M.json( - 200, - models.AppApiPublicV2FunctionCallCallFunctionResponse$inboundSchema, - ), + M.json(200, models.CallFunctionResponse$inboundSchema), M.jsonErr(400, errors.BadRequestError$inboundSchema), M.jsonErr(401, errors.UnauthorizedError$inboundSchema), M.jsonErr(404, errors.NotFoundError$inboundSchema), diff --git a/src/funcs/languageModelsRegisterCustom.ts b/src/funcs/languageModelsRegisterCustom.ts index 91f843c..98903c8 100644 --- a/src/funcs/languageModelsRegisterCustom.ts +++ b/src/funcs/languageModelsRegisterCustom.ts @@ -30,6 +30,8 @@ import { Result } from "../types/fp.js"; * * @remarks * Register a custom language model with the organization that owns the API key. + * + * The model configuration is validated by making a test API call before saving. */ export function languageModelsRegisterCustom( client: OpperCore, diff --git a/src/funcs/languageModelsUpdateCustom.ts b/src/funcs/languageModelsUpdateCustom.ts index b7b7480..12d054e 100644 --- a/src/funcs/languageModelsUpdateCustom.ts +++ b/src/funcs/languageModelsUpdateCustom.ts @@ -31,6 +31,9 @@ import { Result } from "../types/fp.js"; * * @remarks * Update a custom language model. + * + * If identifier, api_key, or extra are changed, the model configuration + * is validated by making a test API call before saving. */ export function languageModelsUpdateCustom( client: OpperCore, diff --git a/src/funcs/stream.ts b/src/funcs/stream.ts index 2069709..1b162cb 100644 --- a/src/funcs/stream.ts +++ b/src/funcs/stream.ts @@ -101,7 +101,7 @@ import { Result } from "../types/fp.js"; */ export function stream( client: OpperCore, - request: models.AppApiPublicV2FunctionCallCallFunctionRequest, + request: models.CallFunctionRequest, options?: RequestOptions, ): APIPromise< Result< @@ -129,7 +129,7 @@ export function stream( async function $do( client: OpperCore, - request: models.AppApiPublicV2FunctionCallCallFunctionRequest, + request: models.CallFunctionRequest, options?: RequestOptions, ): Promise< [ @@ -153,10 +153,7 @@ async function $do( > { const parsed = safeParse( request, - (value) => - models.AppApiPublicV2FunctionCallCallFunctionRequest$outboundSchema.parse( - value, - ), + (value) => models.CallFunctionRequest$outboundSchema.parse(value), "Input validation failed", ); if (!parsed.ok) { diff --git a/src/lib/config.ts b/src/lib/config.ts index 7d8478e..d8f14ff 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "2.0.0", - sdkVersion: "3.4.1", - genVersion: "2.788.15", - userAgent: "speakeasy-sdk/typescript 3.4.1 2.788.15 2.0.0 opperai", + sdkVersion: "3.4.2", + genVersion: "2.801.2", + userAgent: "speakeasy-sdk/typescript 3.4.2 2.801.2 2.0.0 opperai", } as const; diff --git a/src/lib/sdks.ts b/src/lib/sdks.ts index e90348c..f96b579 100644 --- a/src/lib/sdks.ts +++ b/src/lib/sdks.ts @@ -307,9 +307,9 @@ export class ClientSDK { } } -const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/; +const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/; const jsonlLikeContentTypeRE = - /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/; + /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/; async function logRequest(logger: Logger | undefined, req: Request) { if (!logger) { return; diff --git a/src/mcp-server/mcp-server.ts b/src/mcp-server/mcp-server.ts index 8df222d..ed9ca8f 100644 --- a/src/mcp-server/mcp-server.ts +++ b/src/mcp-server/mcp-server.ts @@ -19,7 +19,7 @@ const routes = buildRouteMap({ export const app = buildApplication(routes, { name: "mcp", versionInfo: { - currentVersion: "3.4.1", + currentVersion: "3.4.2", }, }); diff --git a/src/mcp-server/server.ts b/src/mcp-server/server.ts index 4513112..e3308bf 100644 --- a/src/mcp-server/server.ts +++ b/src/mcp-server/server.ts @@ -92,7 +92,7 @@ export function createMCPServer(deps: { }) { const server = new McpServer({ name: "Opper", - version: "3.4.1", + version: "3.4.2", }); const client = new OpperCore({ diff --git a/src/mcp-server/tools/call.ts b/src/mcp-server/tools/call.ts index ac818fd..2c0c83b 100644 --- a/src/mcp-server/tools/call.ts +++ b/src/mcp-server/tools/call.ts @@ -7,7 +7,7 @@ import * as models from "../../models/index.js"; import { formatResult, ToolDefinition } from "../tools.js"; const args = { - request: models.AppApiPublicV2FunctionCallCallFunctionRequest$inboundSchema, + request: models.CallFunctionRequest$inboundSchema, }; export const tool$call: ToolDefinition = { diff --git a/src/mcp-server/tools/languageModelsRegisterCustom.ts b/src/mcp-server/tools/languageModelsRegisterCustom.ts index 3a1fb22..3b98d3b 100644 --- a/src/mcp-server/tools/languageModelsRegisterCustom.ts +++ b/src/mcp-server/tools/languageModelsRegisterCustom.ts @@ -14,7 +14,9 @@ export const tool$languageModelsRegisterCustom: ToolDefinition = { name: "language-models-register-custom", description: `Register Custom Model -Register a custom language model with the organization that owns the API key.`, +Register a custom language model with the organization that owns the API key. + +The model configuration is validated by making a test API call before saving.`, args, tool: async (client, args, ctx) => { const [result, apiCall] = await languageModelsRegisterCustom( diff --git a/src/mcp-server/tools/languageModelsUpdateCustom.ts b/src/mcp-server/tools/languageModelsUpdateCustom.ts index 470ea10..c01a177 100644 --- a/src/mcp-server/tools/languageModelsUpdateCustom.ts +++ b/src/mcp-server/tools/languageModelsUpdateCustom.ts @@ -16,7 +16,10 @@ export const tool$languageModelsUpdateCustom: ToolDefinition = { name: "language-models-update-custom", description: `Update Custom Model -Update a custom language model.`, +Update a custom language model. + +If identifier, api_key, or extra are changed, the model configuration +is validated by making a test API call before saving.`, args, tool: async (client, args, ctx) => { const [result, apiCall] = await languageModelsUpdateCustom( diff --git a/src/mcp-server/tools/stream.ts b/src/mcp-server/tools/stream.ts index ee7c1e0..d83d11c 100644 --- a/src/mcp-server/tools/stream.ts +++ b/src/mcp-server/tools/stream.ts @@ -7,7 +7,7 @@ import * as models from "../../models/index.js"; import { formatResult, ToolDefinition } from "../tools.js"; const args = { - request: models.AppApiPublicV2FunctionCallCallFunctionRequest$inboundSchema, + request: models.CallFunctionRequest$inboundSchema, }; export const tool$stream: ToolDefinition = { diff --git a/src/models/annotation.ts b/src/models/annotation.ts index ee1fbcd..6972769 100644 --- a/src/models/annotation.ts +++ b/src/models/annotation.ts @@ -17,8 +17,14 @@ import { } from "./annotationurlcitation.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * A URL citation when using web search. + */ export type Annotation = { type: "url_citation"; + /** + * A URL citation when using web search. + */ urlCitation: AnnotationURLCitation; additionalProperties?: { [k: string]: any } | undefined; }; diff --git a/src/models/annotationurlcitation.ts b/src/models/annotationurlcitation.ts index f60420d..bc6d603 100644 --- a/src/models/annotationurlcitation.ts +++ b/src/models/annotationurlcitation.ts @@ -11,6 +11,9 @@ import { import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * A URL citation when using web search. + */ export type AnnotationURLCitation = { endIndex: number; startIndex: number; diff --git a/src/models/audio.ts b/src/models/audio.ts index dc5d909..340dc87 100644 --- a/src/models/audio.ts +++ b/src/models/audio.ts @@ -7,6 +7,12 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Data about a previous audio response from the model. + * + * @remarks + * [Learn more](https://platform.openai.com/docs/guides/audio). + */ export type Audio = { id: string; }; diff --git a/src/models/appapipublicv2functioncallcallfunctionrequest.ts b/src/models/callfunctionrequest.ts similarity index 60% rename from src/models/appapipublicv2functioncallcallfunctionrequest.ts rename to src/models/callfunctionrequest.ts index 90e2bf0..8d377ad 100644 --- a/src/models/appapipublicv2functioncallcallfunctionrequest.ts +++ b/src/models/callfunctionrequest.ts @@ -26,7 +26,7 @@ import { TModel$outboundSchema, } from "./tmodel.js"; -export type AppApiPublicV2FunctionCallCallFunctionRequest = { +export type CallFunctionRequest = { /** * Provide a unique name of the task. A function with this name will be created in the project. Functions configuration is overridden by the request parameters. */ @@ -71,32 +71,31 @@ export type AppApiPublicV2FunctionCallCallFunctionRequest = { }; /** @internal */ -export const AppApiPublicV2FunctionCallCallFunctionRequest$inboundSchema: - z.ZodType< - AppApiPublicV2FunctionCallCallFunctionRequest, - z.ZodTypeDef, - unknown - > = z.object({ - name: z.string(), - instructions: z.nullable(z.string()).optional(), - input_schema: z.nullable(z.record(z.any())).optional(), - output_schema: z.nullable(z.record(z.any())).optional(), - input: z.nullable(z.any()).optional(), - model: TModel$inboundSchema.optional(), - examples: z.nullable(z.array(Example$inboundSchema)).optional(), - parent_span_id: z.nullable(z.string()).optional(), - tags: z.nullable(z.record(z.string())).optional(), - configuration: z.nullable(FunctionCallConfigurationInput$inboundSchema) - .optional(), - }).transform((v) => { - return remap$(v, { - "input_schema": "inputSchema", - "output_schema": "outputSchema", - "parent_span_id": "parentSpanId", - }); +export const CallFunctionRequest$inboundSchema: z.ZodType< + CallFunctionRequest, + z.ZodTypeDef, + unknown +> = z.object({ + name: z.string(), + instructions: z.nullable(z.string()).optional(), + input_schema: z.nullable(z.record(z.any())).optional(), + output_schema: z.nullable(z.record(z.any())).optional(), + input: z.nullable(z.any()).optional(), + model: TModel$inboundSchema.optional(), + examples: z.nullable(z.array(Example$inboundSchema)).optional(), + parent_span_id: z.nullable(z.string()).optional(), + tags: z.nullable(z.record(z.string())).optional(), + configuration: z.nullable(FunctionCallConfigurationInput$inboundSchema) + .optional(), +}).transform((v) => { + return remap$(v, { + "input_schema": "inputSchema", + "output_schema": "outputSchema", + "parent_span_id": "parentSpanId", }); +}); /** @internal */ -export type AppApiPublicV2FunctionCallCallFunctionRequest$Outbound = { +export type CallFunctionRequest$Outbound = { name: string; instructions?: string | null | undefined; input_schema?: { [k: string]: any } | null | undefined; @@ -110,53 +109,43 @@ export type AppApiPublicV2FunctionCallCallFunctionRequest$Outbound = { }; /** @internal */ -export const AppApiPublicV2FunctionCallCallFunctionRequest$outboundSchema: - z.ZodType< - AppApiPublicV2FunctionCallCallFunctionRequest$Outbound, - z.ZodTypeDef, - AppApiPublicV2FunctionCallCallFunctionRequest - > = z.object({ - name: z.string(), - instructions: z.nullable(z.string()).optional(), - inputSchema: z.nullable(z.record(z.any())).optional(), - outputSchema: z.nullable(z.record(z.any())).optional(), - input: z.nullable(z.any()).optional(), - model: TModel$outboundSchema.optional(), - examples: z.nullable(z.array(Example$outboundSchema)).optional(), - parentSpanId: z.nullable(z.string()).optional(), - tags: z.nullable(z.record(z.string())).optional(), - configuration: z.nullable(FunctionCallConfigurationInput$outboundSchema) - .optional(), - }).transform((v) => { - return remap$(v, { - inputSchema: "input_schema", - outputSchema: "output_schema", - parentSpanId: "parent_span_id", - }); +export const CallFunctionRequest$outboundSchema: z.ZodType< + CallFunctionRequest$Outbound, + z.ZodTypeDef, + CallFunctionRequest +> = z.object({ + name: z.string(), + instructions: z.nullable(z.string()).optional(), + inputSchema: z.nullable(z.record(z.any())).optional(), + outputSchema: z.nullable(z.record(z.any())).optional(), + input: z.nullable(z.any()).optional(), + model: TModel$outboundSchema.optional(), + examples: z.nullable(z.array(Example$outboundSchema)).optional(), + parentSpanId: z.nullable(z.string()).optional(), + tags: z.nullable(z.record(z.string())).optional(), + configuration: z.nullable(FunctionCallConfigurationInput$outboundSchema) + .optional(), +}).transform((v) => { + return remap$(v, { + inputSchema: "input_schema", + outputSchema: "output_schema", + parentSpanId: "parent_span_id", }); +}); -export function appApiPublicV2FunctionCallCallFunctionRequestToJSON( - appApiPublicV2FunctionCallCallFunctionRequest: - AppApiPublicV2FunctionCallCallFunctionRequest, +export function callFunctionRequestToJSON( + callFunctionRequest: CallFunctionRequest, ): string { return JSON.stringify( - AppApiPublicV2FunctionCallCallFunctionRequest$outboundSchema.parse( - appApiPublicV2FunctionCallCallFunctionRequest, - ), + CallFunctionRequest$outboundSchema.parse(callFunctionRequest), ); } -export function appApiPublicV2FunctionCallCallFunctionRequestFromJSON( +export function callFunctionRequestFromJSON( jsonString: string, -): SafeParseResult< - AppApiPublicV2FunctionCallCallFunctionRequest, - SDKValidationError -> { +): SafeParseResult { return safeParse( jsonString, - (x) => - AppApiPublicV2FunctionCallCallFunctionRequest$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'AppApiPublicV2FunctionCallCallFunctionRequest' from JSON`, + (x) => CallFunctionRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'CallFunctionRequest' from JSON`, ); } diff --git a/src/models/appapipublicv2functioncallcallfunctionresponse.ts b/src/models/callfunctionresponse.ts similarity index 57% rename from src/models/appapipublicv2functioncallcallfunctionresponse.ts rename to src/models/callfunctionresponse.ts index ddef5eb..a0e8a95 100644 --- a/src/models/appapipublicv2functioncallcallfunctionresponse.ts +++ b/src/models/callfunctionresponse.ts @@ -13,7 +13,7 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js"; */ export type JsonPayload = { [k: string]: any } | Array | any; -export type AppApiPublicV2FunctionCallCallFunctionResponse = { +export type CallFunctionResponse = { /** * The ID of the span of the call */ @@ -74,29 +74,28 @@ export function jsonPayloadFromJSON( } /** @internal */ -export const AppApiPublicV2FunctionCallCallFunctionResponse$inboundSchema: - z.ZodType< - AppApiPublicV2FunctionCallCallFunctionResponse, - z.ZodTypeDef, - unknown - > = z.object({ - span_id: z.string(), - message: z.nullable(z.string()).optional(), - json_payload: z.nullable( - z.union([z.record(z.any()), z.array(z.any()), z.any()]), - ).optional(), - cached: z.nullable(z.boolean()).optional(), - images: z.nullable(z.array(z.string())).optional(), - usage: z.nullable(z.record(z.any())).optional(), - cost: z.nullable(z.record(z.any())).optional(), - }).transform((v) => { - return remap$(v, { - "span_id": "spanId", - "json_payload": "jsonPayload", - }); +export const CallFunctionResponse$inboundSchema: z.ZodType< + CallFunctionResponse, + z.ZodTypeDef, + unknown +> = z.object({ + span_id: z.string(), + message: z.nullable(z.string()).optional(), + json_payload: z.nullable( + z.union([z.record(z.any()), z.array(z.any()), z.any()]), + ).optional(), + cached: z.nullable(z.boolean()).optional(), + images: z.nullable(z.array(z.string())).optional(), + usage: z.nullable(z.record(z.any())).optional(), + cost: z.nullable(z.record(z.any())).optional(), +}).transform((v) => { + return remap$(v, { + "span_id": "spanId", + "json_payload": "jsonPayload", }); +}); /** @internal */ -export type AppApiPublicV2FunctionCallCallFunctionResponse$Outbound = { +export type CallFunctionResponse$Outbound = { span_id: string; message?: string | null | undefined; json_payload?: { [k: string]: any } | Array | any | null | undefined; @@ -107,50 +106,40 @@ export type AppApiPublicV2FunctionCallCallFunctionResponse$Outbound = { }; /** @internal */ -export const AppApiPublicV2FunctionCallCallFunctionResponse$outboundSchema: - z.ZodType< - AppApiPublicV2FunctionCallCallFunctionResponse$Outbound, - z.ZodTypeDef, - AppApiPublicV2FunctionCallCallFunctionResponse - > = z.object({ - spanId: z.string(), - message: z.nullable(z.string()).optional(), - jsonPayload: z.nullable( - z.union([z.record(z.any()), z.array(z.any()), z.any()]), - ).optional(), - cached: z.nullable(z.boolean()).optional(), - images: z.nullable(z.array(z.string())).optional(), - usage: z.nullable(z.record(z.any())).optional(), - cost: z.nullable(z.record(z.any())).optional(), - }).transform((v) => { - return remap$(v, { - spanId: "span_id", - jsonPayload: "json_payload", - }); +export const CallFunctionResponse$outboundSchema: z.ZodType< + CallFunctionResponse$Outbound, + z.ZodTypeDef, + CallFunctionResponse +> = z.object({ + spanId: z.string(), + message: z.nullable(z.string()).optional(), + jsonPayload: z.nullable( + z.union([z.record(z.any()), z.array(z.any()), z.any()]), + ).optional(), + cached: z.nullable(z.boolean()).optional(), + images: z.nullable(z.array(z.string())).optional(), + usage: z.nullable(z.record(z.any())).optional(), + cost: z.nullable(z.record(z.any())).optional(), +}).transform((v) => { + return remap$(v, { + spanId: "span_id", + jsonPayload: "json_payload", }); +}); -export function appApiPublicV2FunctionCallCallFunctionResponseToJSON( - appApiPublicV2FunctionCallCallFunctionResponse: - AppApiPublicV2FunctionCallCallFunctionResponse, +export function callFunctionResponseToJSON( + callFunctionResponse: CallFunctionResponse, ): string { return JSON.stringify( - AppApiPublicV2FunctionCallCallFunctionResponse$outboundSchema.parse( - appApiPublicV2FunctionCallCallFunctionResponse, - ), + CallFunctionResponse$outboundSchema.parse(callFunctionResponse), ); } -export function appApiPublicV2FunctionCallCallFunctionResponseFromJSON( +export function callFunctionResponseFromJSON( jsonString: string, -): SafeParseResult< - AppApiPublicV2FunctionCallCallFunctionResponse, - SDKValidationError -> { +): SafeParseResult { return safeParse( jsonString, - (x) => - AppApiPublicV2FunctionCallCallFunctionResponse$inboundSchema.parse( - JSON.parse(x), - ), - `Failed to parse 'AppApiPublicV2FunctionCallCallFunctionResponse' from JSON`, + (x) => CallFunctionResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'CallFunctionResponse' from JSON`, ); } diff --git a/src/models/chatcompletion.ts b/src/models/chatcompletion.ts index 088a344..b5e0eaf 100644 --- a/src/models/chatcompletion.ts +++ b/src/models/chatcompletion.ts @@ -35,6 +35,9 @@ export type ChatCompletionServiceTier = ClosedEnum< typeof ChatCompletionServiceTier >; +/** + * Represents a chat completion response returned by model, based on the provided input. + */ export type ChatCompletion = { id: string; choices: Array; diff --git a/src/models/chatcompletionallowedtoolchoiceparam.ts b/src/models/chatcompletionallowedtoolchoiceparam.ts index 03882ec..832e5ee 100644 --- a/src/models/chatcompletionallowedtoolchoiceparam.ts +++ b/src/models/chatcompletionallowedtoolchoiceparam.ts @@ -14,7 +14,13 @@ import { } from "./chatcompletionallowedtoolsparam.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Constrains the tools available to the model to a pre-defined set. + */ export type ChatCompletionAllowedToolChoiceParam = { + /** + * Constrains the tools available to the model to a pre-defined set. + */ allowedTools: ChatCompletionAllowedToolsParam; type: "allowed_tools"; }; diff --git a/src/models/chatcompletionallowedtoolsparam.ts b/src/models/chatcompletionallowedtoolsparam.ts index c2f6740..fee3108 100644 --- a/src/models/chatcompletionallowedtoolsparam.ts +++ b/src/models/chatcompletionallowedtoolsparam.ts @@ -14,6 +14,9 @@ export const Mode = { } as const; export type Mode = ClosedEnum; +/** + * Constrains the tools available to the model to a pre-defined set. + */ export type ChatCompletionAllowedToolsParam = { mode: Mode; tools: Array<{ [k: string]: any }>; diff --git a/src/models/chatcompletionassistantmessageparam.ts b/src/models/chatcompletionassistantmessageparam.ts index 7f2216b..8f84239 100644 --- a/src/models/chatcompletionassistantmessageparam.ts +++ b/src/models/chatcompletionassistantmessageparam.ts @@ -59,6 +59,9 @@ export type ChatCompletionAssistantMessageParamToolCall = | ChatCompletionMessageFunctionToolCallParam | ChatCompletionMessageCustomToolCallParam; +/** + * Messages sent by the model in response to user messages. + */ export type ChatCompletionAssistantMessageParam = { role: "assistant"; audio?: Audio | null | undefined; diff --git a/src/models/chatcompletionaudio.ts b/src/models/chatcompletionaudio.ts index 895976f..e0aa378 100644 --- a/src/models/chatcompletionaudio.ts +++ b/src/models/chatcompletionaudio.ts @@ -11,6 +11,12 @@ import { import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * If the audio output modality is requested, this object contains data + * + * @remarks + * about the audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio). + */ export type ChatCompletionAudio = { id: string; data: string; diff --git a/src/models/chatcompletionaudioparam.ts b/src/models/chatcompletionaudioparam.ts index 9f05ab3..ee8f36d 100644 --- a/src/models/chatcompletionaudioparam.ts +++ b/src/models/chatcompletionaudioparam.ts @@ -29,11 +29,21 @@ export const VoiceEnum = { Sage: "sage", Shimmer: "shimmer", Verse: "verse", + Marin: "marin", + Cedar: "cedar", } as const; export type VoiceEnum = ClosedEnum; export type Voice = string | VoiceEnum; +/** + * Parameters for audio output. + * + * @remarks + * + * Required when audio output is requested with + * `modalities: ["audio"]`. [Learn more](https://platform.openai.com/docs/guides/audio). + */ export type ChatCompletionAudioParam = { format: ChatCompletionAudioParamFormat; voice: string | VoiceEnum; diff --git a/src/models/chatcompletioncontentpartimageparam.ts b/src/models/chatcompletioncontentpartimageparam.ts index 106f92d..4fe3d2b 100644 --- a/src/models/chatcompletioncontentpartimageparam.ts +++ b/src/models/chatcompletioncontentpartimageparam.ts @@ -14,6 +14,9 @@ import { ImageURL$outboundSchema, } from "./imageurl.js"; +/** + * Learn about [image inputs](https://platform.openai.com/docs/guides/vision). + */ export type ChatCompletionContentPartImageParam = { imageUrl: ImageURL; type: "image_url"; diff --git a/src/models/chatcompletioncontentpartinputaudioparam.ts b/src/models/chatcompletioncontentpartinputaudioparam.ts index dbdf214..7722f71 100644 --- a/src/models/chatcompletioncontentpartinputaudioparam.ts +++ b/src/models/chatcompletioncontentpartinputaudioparam.ts @@ -14,6 +14,9 @@ import { InputAudio$outboundSchema, } from "./inputaudio.js"; +/** + * Learn about [audio inputs](https://platform.openai.com/docs/guides/audio). + */ export type ChatCompletionContentPartInputAudioParam = { inputAudio: InputAudio; type: "input_audio"; diff --git a/src/models/chatcompletioncontentparttextparam.ts b/src/models/chatcompletioncontentparttextparam.ts index 76e3232..ba04c04 100644 --- a/src/models/chatcompletioncontentparttextparam.ts +++ b/src/models/chatcompletioncontentparttextparam.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation). + */ export type ChatCompletionContentPartTextParam = { text: string; type: "text"; diff --git a/src/models/chatcompletioncustomtoolparam.ts b/src/models/chatcompletioncustomtoolparam.ts index 297e9cd..53ec79f 100644 --- a/src/models/chatcompletioncustomtoolparam.ts +++ b/src/models/chatcompletioncustomtoolparam.ts @@ -13,7 +13,13 @@ import { OpenaiTypesChatChatCompletionCustomToolParamCustom$outboundSchema, } from "./openaitypeschatchatcompletioncustomtoolparamcustom.js"; +/** + * A custom tool that processes input using a specified format. + */ export type ChatCompletionCustomToolParam = { + /** + * Properties of the custom tool. + */ custom: OpenaiTypesChatChatCompletionCustomToolParamCustom; type: "custom"; }; diff --git a/src/models/chatcompletiondevelopermessageparam.ts b/src/models/chatcompletiondevelopermessageparam.ts index 3e8f738..582ed4c 100644 --- a/src/models/chatcompletiondevelopermessageparam.ts +++ b/src/models/chatcompletiondevelopermessageparam.ts @@ -17,6 +17,13 @@ export type ChatCompletionDeveloperMessageParamContent = | string | Array; +/** + * Developer-provided instructions that the model should follow, regardless of + * + * @remarks + * messages sent by the user. With o1 models and newer, `developer` messages + * replace the previous `system` messages. + */ export type ChatCompletionDeveloperMessageParam = { content: string | Array; role: "developer"; diff --git a/src/models/chatcompletionfunctioncalloptionparam.ts b/src/models/chatcompletionfunctioncalloptionparam.ts index 56fbf8e..bebae7f 100644 --- a/src/models/chatcompletionfunctioncalloptionparam.ts +++ b/src/models/chatcompletionfunctioncalloptionparam.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + */ export type ChatCompletionFunctionCallOptionParam = { name: string; }; diff --git a/src/models/chatcompletionfunctiontoolparam.ts b/src/models/chatcompletionfunctiontoolparam.ts index 9528caa..45e4649 100644 --- a/src/models/chatcompletionfunctiontoolparam.ts +++ b/src/models/chatcompletionfunctiontoolparam.ts @@ -13,6 +13,9 @@ import { FunctionDefinition$outboundSchema, } from "./functiondefinition.js"; +/** + * A function tool that can be used to generate a response. + */ export type ChatCompletionFunctionToolParam = { function: FunctionDefinition; type: "function"; diff --git a/src/models/chatcompletionmessage.ts b/src/models/chatcompletionmessage.ts index cd85096..63b0509 100644 --- a/src/models/chatcompletionmessage.ts +++ b/src/models/chatcompletionmessage.ts @@ -45,6 +45,9 @@ export type ChatCompletionMessageToolCall = | ChatCompletionMessageFunctionToolCall | ChatCompletionMessageCustomToolCall; +/** + * A chat completion message generated by the model. + */ export type ChatCompletionMessage = { content?: string | null | undefined; refusal?: string | null | undefined; diff --git a/src/models/chatcompletionmessagecustomtoolcall.ts b/src/models/chatcompletionmessagecustomtoolcall.ts index c9b7a1e..2d473f7 100644 --- a/src/models/chatcompletionmessagecustomtoolcall.ts +++ b/src/models/chatcompletionmessagecustomtoolcall.ts @@ -17,8 +17,14 @@ import { } from "./customoutput.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * A call to a custom tool created by the model. + */ export type ChatCompletionMessageCustomToolCall = { id: string; + /** + * The custom tool that the model called. + */ custom: CustomOutput; type: "custom"; additionalProperties?: { [k: string]: any } | undefined; diff --git a/src/models/chatcompletionmessagecustomtoolcallparam.ts b/src/models/chatcompletionmessagecustomtoolcallparam.ts index 9fa8e1a..66ee754 100644 --- a/src/models/chatcompletionmessagecustomtoolcallparam.ts +++ b/src/models/chatcompletionmessagecustomtoolcallparam.ts @@ -13,8 +13,14 @@ import { OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom$outboundSchema, } from "./openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.js"; +/** + * A call to a custom tool created by the model. + */ export type ChatCompletionMessageCustomToolCallParam = { id: string; + /** + * The custom tool that the model called. + */ custom: OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom; type: "custom"; }; diff --git a/src/models/chatcompletionmessagefunctiontoolcall.ts b/src/models/chatcompletionmessagefunctiontoolcall.ts index ed6beaa..7c258c7 100644 --- a/src/models/chatcompletionmessagefunctiontoolcall.ts +++ b/src/models/chatcompletionmessagefunctiontoolcall.ts @@ -17,8 +17,14 @@ import { FunctionOutput$outboundSchema, } from "./functionoutput.js"; +/** + * A call to a function tool created by the model. + */ export type ChatCompletionMessageFunctionToolCall = { id: string; + /** + * The function that the model called. + */ function: FunctionOutput; type: "function"; additionalProperties?: { [k: string]: any } | undefined; diff --git a/src/models/chatcompletionmessagefunctiontoolcallparam.ts b/src/models/chatcompletionmessagefunctiontoolcallparam.ts index bc146a1..3145fe3 100644 --- a/src/models/chatcompletionmessagefunctiontoolcallparam.ts +++ b/src/models/chatcompletionmessagefunctiontoolcallparam.ts @@ -13,8 +13,14 @@ import { OpenaiTypesChatChatCompletionMessageFunctionToolCallParamFunction$outboundSchema, } from "./openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.js"; +/** + * A call to a function tool created by the model. + */ export type ChatCompletionMessageFunctionToolCallParam = { id: string; + /** + * The function that the model called. + */ function: OpenaiTypesChatChatCompletionMessageFunctionToolCallParamFunction; type: "function"; }; diff --git a/src/models/chatcompletionnamedtoolchoicecustomparam.ts b/src/models/chatcompletionnamedtoolchoicecustomparam.ts index b1a1b11..fffd835 100644 --- a/src/models/chatcompletionnamedtoolchoicecustomparam.ts +++ b/src/models/chatcompletionnamedtoolchoicecustomparam.ts @@ -13,6 +13,13 @@ import { OpenaiTypesChatChatCompletionNamedToolChoiceCustomParamCustom$outboundSchema, } from "./openaitypeschatchatcompletionnamedtoolchoicecustomparamcustom.js"; +/** + * Specifies a tool the model should use. + * + * @remarks + * + * Use to force the model to call a specific custom tool. + */ export type ChatCompletionNamedToolChoiceCustomParam = { custom: OpenaiTypesChatChatCompletionNamedToolChoiceCustomParamCustom; type: "custom"; diff --git a/src/models/chatcompletionnamedtoolchoiceparam.ts b/src/models/chatcompletionnamedtoolchoiceparam.ts index 18f7b03..c6bdadc 100644 --- a/src/models/chatcompletionnamedtoolchoiceparam.ts +++ b/src/models/chatcompletionnamedtoolchoiceparam.ts @@ -13,6 +13,13 @@ import { OpenaiTypesChatChatCompletionNamedToolChoiceParamFunction$outboundSchema, } from "./openaitypeschatchatcompletionnamedtoolchoiceparamfunction.js"; +/** + * Specifies a tool the model should use. + * + * @remarks + * + * Use to force the model to call a specific function. + */ export type ChatCompletionNamedToolChoiceParam = { function: OpenaiTypesChatChatCompletionNamedToolChoiceParamFunction; type: "function"; diff --git a/src/models/chatcompletionnonstreaming.ts b/src/models/chatcompletionnonstreaming.ts index ea68bd8..cc2a8e3 100644 --- a/src/models/chatcompletionnonstreaming.ts +++ b/src/models/chatcompletionnonstreaming.ts @@ -163,11 +163,21 @@ export type ChatCompletionNonStreamingModality = ClosedEnum< typeof ChatCompletionNonStreamingModality >; +export const ChatCompletionNonStreamingPromptCacheRetention = { + InMemory: "in-memory", + TwentyFourh: "24h", +} as const; +export type ChatCompletionNonStreamingPromptCacheRetention = ClosedEnum< + typeof ChatCompletionNonStreamingPromptCacheRetention +>; + export const ChatCompletionNonStreamingReasoningEffort = { + None: "none", Minimal: "minimal", Low: "low", Medium: "medium", High: "high", + Xhigh: "xhigh", } as const; export type ChatCompletionNonStreamingReasoningEffort = ClosedEnum< typeof ChatCompletionNonStreamingReasoningEffort @@ -247,6 +257,10 @@ export type ChatCompletionNonStreaming = { prediction?: ChatCompletionPredictionContentParam | null | undefined; presencePenalty?: number | null | undefined; promptCacheKey?: string | undefined; + promptCacheRetention?: + | ChatCompletionNonStreamingPromptCacheRetention + | null + | undefined; reasoningEffort?: | ChatCompletionNonStreamingReasoningEffort | null @@ -276,6 +290,12 @@ export type ChatCompletionNonStreaming = { topP?: number | null | undefined; user?: string | undefined; verbosity?: ChatCompletionNonStreamingVerbosity | null | undefined; + /** + * This tool searches the web for relevant results to use in a response. + * + * @remarks + * Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). + */ webSearchOptions?: WebSearchOptions | undefined; stream?: false | null | undefined; tags?: { [k: string]: any } | null | undefined; @@ -407,6 +427,15 @@ export const ChatCompletionNonStreamingModality$outboundSchema: z.ZodNativeEnum< typeof ChatCompletionNonStreamingModality > = ChatCompletionNonStreamingModality$inboundSchema; +/** @internal */ +export const ChatCompletionNonStreamingPromptCacheRetention$inboundSchema: + z.ZodNativeEnum = z + .nativeEnum(ChatCompletionNonStreamingPromptCacheRetention); +/** @internal */ +export const ChatCompletionNonStreamingPromptCacheRetention$outboundSchema: + z.ZodNativeEnum = + ChatCompletionNonStreamingPromptCacheRetention$inboundSchema; + /** @internal */ export const ChatCompletionNonStreamingReasoningEffort$inboundSchema: z.ZodNativeEnum = z @@ -672,6 +701,9 @@ export const ChatCompletionNonStreaming$inboundSchema: z.ZodType< .optional(), presence_penalty: z.nullable(z.number()).optional(), prompt_cache_key: z.string().optional(), + prompt_cache_retention: z.nullable( + ChatCompletionNonStreamingPromptCacheRetention$inboundSchema, + ).optional(), reasoning_effort: z.nullable( ChatCompletionNonStreamingReasoningEffort$inboundSchema, ).optional(), @@ -720,6 +752,7 @@ export const ChatCompletionNonStreaming$inboundSchema: z.ZodType< "parallel_tool_calls": "parallelToolCalls", "presence_penalty": "presencePenalty", "prompt_cache_key": "promptCacheKey", + "prompt_cache_retention": "promptCacheRetention", "reasoning_effort": "reasoningEffort", "response_format": "responseFormat", "safety_identifier": "safetyIdentifier", @@ -763,6 +796,7 @@ export type ChatCompletionNonStreaming$Outbound = { prediction?: ChatCompletionPredictionContentParam$Outbound | null | undefined; presence_penalty?: number | null | undefined; prompt_cache_key?: string | undefined; + prompt_cache_retention?: string | null | undefined; reasoning_effort?: string | null | undefined; response_format?: | ResponseFormatText$Outbound @@ -838,6 +872,9 @@ export const ChatCompletionNonStreaming$outboundSchema: z.ZodType< .optional(), presencePenalty: z.nullable(z.number()).optional(), promptCacheKey: z.string().optional(), + promptCacheRetention: z.nullable( + ChatCompletionNonStreamingPromptCacheRetention$outboundSchema, + ).optional(), reasoningEffort: z.nullable( ChatCompletionNonStreamingReasoningEffort$outboundSchema, ).optional(), @@ -886,6 +923,7 @@ export const ChatCompletionNonStreaming$outboundSchema: z.ZodType< parallelToolCalls: "parallel_tool_calls", presencePenalty: "presence_penalty", promptCacheKey: "prompt_cache_key", + promptCacheRetention: "prompt_cache_retention", reasoningEffort: "reasoning_effort", responseFormat: "response_format", safetyIdentifier: "safety_identifier", diff --git a/src/models/chatcompletionpredictioncontentparam.ts b/src/models/chatcompletionpredictioncontentparam.ts index 742bedf..7b1b240 100644 --- a/src/models/chatcompletionpredictioncontentparam.ts +++ b/src/models/chatcompletionpredictioncontentparam.ts @@ -17,6 +17,12 @@ export type ChatCompletionPredictionContentParamContent = | string | Array; +/** + * Static predicted output content, such as the content of a text file that is + * + * @remarks + * being regenerated. + */ export type ChatCompletionPredictionContentParam = { content: string | Array; type: "content"; diff --git a/src/models/chatcompletionstreaming.ts b/src/models/chatcompletionstreaming.ts index cdbbf51..8dca463 100644 --- a/src/models/chatcompletionstreaming.ts +++ b/src/models/chatcompletionstreaming.ts @@ -163,11 +163,21 @@ export type ChatCompletionStreamingModality = ClosedEnum< typeof ChatCompletionStreamingModality >; +export const ChatCompletionStreamingPromptCacheRetention = { + InMemory: "in-memory", + TwentyFourh: "24h", +} as const; +export type ChatCompletionStreamingPromptCacheRetention = ClosedEnum< + typeof ChatCompletionStreamingPromptCacheRetention +>; + export const ChatCompletionStreamingReasoningEffort = { + None: "none", Minimal: "minimal", Low: "low", Medium: "medium", High: "high", + Xhigh: "xhigh", } as const; export type ChatCompletionStreamingReasoningEffort = ClosedEnum< typeof ChatCompletionStreamingReasoningEffort @@ -247,6 +257,10 @@ export type ChatCompletionStreaming = { prediction?: ChatCompletionPredictionContentParam | null | undefined; presencePenalty?: number | null | undefined; promptCacheKey?: string | undefined; + promptCacheRetention?: + | ChatCompletionStreamingPromptCacheRetention + | null + | undefined; reasoningEffort?: ChatCompletionStreamingReasoningEffort | null | undefined; responseFormat?: | ResponseFormatText @@ -273,6 +287,12 @@ export type ChatCompletionStreaming = { topP?: number | null | undefined; user?: string | undefined; verbosity?: ChatCompletionStreamingVerbosity | null | undefined; + /** + * This tool searches the web for relevant results to use in a response. + * + * @remarks + * Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). + */ webSearchOptions?: WebSearchOptions | undefined; stream: true; tags?: { [k: string]: any } | null | undefined; @@ -402,6 +422,15 @@ export const ChatCompletionStreamingModality$outboundSchema: z.ZodNativeEnum< typeof ChatCompletionStreamingModality > = ChatCompletionStreamingModality$inboundSchema; +/** @internal */ +export const ChatCompletionStreamingPromptCacheRetention$inboundSchema: + z.ZodNativeEnum = z + .nativeEnum(ChatCompletionStreamingPromptCacheRetention); +/** @internal */ +export const ChatCompletionStreamingPromptCacheRetention$outboundSchema: + z.ZodNativeEnum = + ChatCompletionStreamingPromptCacheRetention$inboundSchema; + /** @internal */ export const ChatCompletionStreamingReasoningEffort$inboundSchema: z.ZodNativeEnum = z.nativeEnum( @@ -655,6 +684,9 @@ export const ChatCompletionStreaming$inboundSchema: z.ZodType< .optional(), presence_penalty: z.nullable(z.number()).optional(), prompt_cache_key: z.string().optional(), + prompt_cache_retention: z.nullable( + ChatCompletionStreamingPromptCacheRetention$inboundSchema, + ).optional(), reasoning_effort: z.nullable( ChatCompletionStreamingReasoningEffort$inboundSchema, ).optional(), @@ -703,6 +735,7 @@ export const ChatCompletionStreaming$inboundSchema: z.ZodType< "parallel_tool_calls": "parallelToolCalls", "presence_penalty": "presencePenalty", "prompt_cache_key": "promptCacheKey", + "prompt_cache_retention": "promptCacheRetention", "reasoning_effort": "reasoningEffort", "response_format": "responseFormat", "safety_identifier": "safetyIdentifier", @@ -746,6 +779,7 @@ export type ChatCompletionStreaming$Outbound = { prediction?: ChatCompletionPredictionContentParam$Outbound | null | undefined; presence_penalty?: number | null | undefined; prompt_cache_key?: string | undefined; + prompt_cache_retention?: string | null | undefined; reasoning_effort?: string | null | undefined; response_format?: | ResponseFormatText$Outbound @@ -821,6 +855,9 @@ export const ChatCompletionStreaming$outboundSchema: z.ZodType< .optional(), presencePenalty: z.nullable(z.number()).optional(), promptCacheKey: z.string().optional(), + promptCacheRetention: z.nullable( + ChatCompletionStreamingPromptCacheRetention$outboundSchema, + ).optional(), reasoningEffort: z.nullable( ChatCompletionStreamingReasoningEffort$outboundSchema, ).optional(), @@ -869,6 +906,7 @@ export const ChatCompletionStreaming$outboundSchema: z.ZodType< parallelToolCalls: "parallel_tool_calls", presencePenalty: "presence_penalty", promptCacheKey: "prompt_cache_key", + promptCacheRetention: "prompt_cache_retention", reasoningEffort: "reasoning_effort", responseFormat: "response_format", safetyIdentifier: "safety_identifier", diff --git a/src/models/chatcompletionstreamoptionsparam.ts b/src/models/chatcompletionstreamoptionsparam.ts index 879167b..226ba9c 100644 --- a/src/models/chatcompletionstreamoptionsparam.ts +++ b/src/models/chatcompletionstreamoptionsparam.ts @@ -8,6 +8,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Options for streaming response. Only set this when you set `stream: true`. + */ export type ChatCompletionStreamOptionsParam = { includeObfuscation?: boolean | undefined; includeUsage?: boolean | undefined; diff --git a/src/models/chatcompletionsystemmessageparam.ts b/src/models/chatcompletionsystemmessageparam.ts index 783b501..57acb7f 100644 --- a/src/models/chatcompletionsystemmessageparam.ts +++ b/src/models/chatcompletionsystemmessageparam.ts @@ -17,6 +17,13 @@ export type ChatCompletionSystemMessageParamContent = | string | Array; +/** + * Developer-provided instructions that the model should follow, regardless of + * + * @remarks + * messages sent by the user. With o1 models and newer, use `developer` messages + * for this purpose instead. + */ export type ChatCompletionSystemMessageParam = { content: string | Array; role: "system"; diff --git a/src/models/chatcompletionusermessageparam.ts b/src/models/chatcompletionusermessageparam.ts index 909ae30..8c17b41 100644 --- a/src/models/chatcompletionusermessageparam.ts +++ b/src/models/chatcompletionusermessageparam.ts @@ -46,6 +46,12 @@ export type ChatCompletionUserMessageParamContent2 = | FileT >; +/** + * Messages sent by an end user, containing prompts or additional context + * + * @remarks + * information. + */ export type ChatCompletionUserMessageParam = { content: | string diff --git a/src/models/choice.ts b/src/models/choice.ts index bfae543..bf450e7 100644 --- a/src/models/choice.ts +++ b/src/models/choice.ts @@ -37,6 +37,9 @@ export type Choice = { finishReason: FinishReason; index: number; logprobs?: ChoiceLogprobs | null | undefined; + /** + * A chat completion message generated by the model. + */ message: ChatCompletionMessage; additionalProperties?: { [k: string]: any } | undefined; }; diff --git a/src/models/choicelogprobs.ts b/src/models/choicelogprobs.ts index 9dbb1ab..a6246cc 100644 --- a/src/models/choicelogprobs.ts +++ b/src/models/choicelogprobs.ts @@ -17,6 +17,9 @@ import { } from "./chatcompletiontokenlogprob.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Log probability information for the choice. + */ export type ChoiceLogprobs = { content?: Array | null | undefined; refusal?: Array | null | undefined; diff --git a/src/models/completiontokensdetails.ts b/src/models/completiontokensdetails.ts index f3deeb2..4e57c87 100644 --- a/src/models/completiontokensdetails.ts +++ b/src/models/completiontokensdetails.ts @@ -11,6 +11,9 @@ import { import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Breakdown of tokens used in a completion. + */ export type CompletionTokensDetails = { acceptedPredictionTokens?: number | null | undefined; audioTokens?: number | null | undefined; diff --git a/src/models/completionusage.ts b/src/models/completionusage.ts index 29befa9..6afb747 100644 --- a/src/models/completionusage.ts +++ b/src/models/completionusage.ts @@ -23,6 +23,9 @@ import { PromptTokensDetails$outboundSchema, } from "./prompttokensdetails.js"; +/** + * Usage statistics for the completion request. + */ export type CompletionUsage = { completionTokens: number; promptTokens: number; diff --git a/src/models/customformatgrammar.ts b/src/models/customformatgrammar.ts index 48bf703..f7da55c 100644 --- a/src/models/customformatgrammar.ts +++ b/src/models/customformatgrammar.ts @@ -13,7 +13,13 @@ import { } from "./customformatgrammargrammar.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * A grammar defined by the user. + */ export type CustomFormatGrammar = { + /** + * Your chosen grammar. + */ grammar: CustomFormatGrammarGrammar; type: "grammar"; }; diff --git a/src/models/customformatgrammargrammar.ts b/src/models/customformatgrammargrammar.ts index edf7b0d..45e1cec 100644 --- a/src/models/customformatgrammargrammar.ts +++ b/src/models/customformatgrammargrammar.ts @@ -14,6 +14,9 @@ export const Syntax = { } as const; export type Syntax = ClosedEnum; +/** + * Your chosen grammar. + */ export type CustomFormatGrammarGrammar = { definition: string; syntax: Syntax; diff --git a/src/models/customformattext.ts b/src/models/customformattext.ts index 93b34d3..abe905b 100644 --- a/src/models/customformattext.ts +++ b/src/models/customformattext.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Unconstrained free-form text. + */ export type CustomFormatText = { type: "text"; }; diff --git a/src/models/customoutput.ts b/src/models/customoutput.ts index 1395341..f6e9281 100644 --- a/src/models/customoutput.ts +++ b/src/models/customoutput.ts @@ -11,6 +11,9 @@ import { import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * The custom tool that the model called. + */ export type CustomOutput = { input: string; name: string; diff --git a/src/models/file.ts b/src/models/file.ts index 4013883..bfefaba 100644 --- a/src/models/file.ts +++ b/src/models/file.ts @@ -13,6 +13,9 @@ import { FileFile$outboundSchema, } from "./filefile.js"; +/** + * Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation. + */ export type FileT = { file: FileFile; type: "file"; diff --git a/src/models/functioncallinput.ts b/src/models/functioncallinput.ts index 917172c..136c472 100644 --- a/src/models/functioncallinput.ts +++ b/src/models/functioncallinput.ts @@ -7,6 +7,13 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Deprecated and replaced by `tool_calls`. + * + * @remarks + * + * The name and arguments of a function that should be called, as generated by the model. + */ export type FunctionCallInput = { arguments: string; name: string; diff --git a/src/models/functioncalloutput.ts b/src/models/functioncalloutput.ts index 929ea76..3a95d41 100644 --- a/src/models/functioncalloutput.ts +++ b/src/models/functioncalloutput.ts @@ -11,6 +11,13 @@ import { import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Deprecated and replaced by `tool_calls`. + * + * @remarks + * + * The name and arguments of a function that should be called, as generated by the model. + */ export type FunctionCallOutput = { arguments: string; name: string; diff --git a/src/models/functionoutput.ts b/src/models/functionoutput.ts index 1b8bec5..dbb5265 100644 --- a/src/models/functionoutput.ts +++ b/src/models/functionoutput.ts @@ -11,6 +11,9 @@ import { import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * The function that the model called. + */ export type FunctionOutput = { arguments: string; name: string; diff --git a/src/models/index.ts b/src/models/index.ts index 60b3a6a..daf80d2 100644 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -5,12 +5,12 @@ export * from "./addrequest.js"; export * from "./annotation.js"; export * from "./annotationurlcitation.js"; -export * from "./appapipublicv2functioncallcallfunctionrequest.js"; -export * from "./appapipublicv2functioncallcallfunctionresponse.js"; export * from "./appapipublicv2functionscallfunctionrequest.js"; export * from "./appapipublicv2functionscallfunctionresponse.js"; export * from "./audio.js"; export * from "./bodyuploadfileknowledgeknowledgebaseiduploadpost.js"; +export * from "./callfunctionrequest.js"; +export * from "./callfunctionresponse.js"; export * from "./chatcompletion.js"; export * from "./chatcompletionallowedtoolchoiceparam.js"; export * from "./chatcompletionallowedtoolsparam.js"; diff --git a/src/models/jsonschema.ts b/src/models/jsonschema.ts index 670b729..3073f39 100644 --- a/src/models/jsonschema.ts +++ b/src/models/jsonschema.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Structured Outputs configuration options, including a JSON Schema. + */ export type JSONSchema = { name: string; description?: string | undefined; diff --git a/src/models/openaitypeschatchatcompletioncustomtoolparamcustom.ts b/src/models/openaitypeschatchatcompletioncustomtoolparamcustom.ts index b5b8319..e3a43fc 100644 --- a/src/models/openaitypeschatchatcompletioncustomtoolparamcustom.ts +++ b/src/models/openaitypeschatchatcompletioncustomtoolparamcustom.ts @@ -21,6 +21,9 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js"; export type Format = CustomFormatText | CustomFormatGrammar; +/** + * Properties of the custom tool. + */ export type OpenaiTypesChatChatCompletionCustomToolParamCustom = { name: string; description?: string | undefined; diff --git a/src/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.ts b/src/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.ts index c4ba71b..0177e70 100644 --- a/src/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.ts +++ b/src/models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * The custom tool that the model called. + */ export type OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom = { input: string; name: string; diff --git a/src/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.ts b/src/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.ts index c404a07..afb7684 100644 --- a/src/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.ts +++ b/src/models/openaitypeschatchatcompletionmessagefunctiontoolcallparamfunction.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * The function that the model called. + */ export type OpenaiTypesChatChatCompletionMessageFunctionToolCallParamFunction = { arguments: string; diff --git a/src/models/prompttokensdetails.ts b/src/models/prompttokensdetails.ts index d22c01a..2794855 100644 --- a/src/models/prompttokensdetails.ts +++ b/src/models/prompttokensdetails.ts @@ -11,6 +11,9 @@ import { import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Breakdown of tokens used in the prompt. + */ export type PromptTokensDetails = { audioTokens?: number | null | undefined; cachedTokens?: number | null | undefined; diff --git a/src/models/responseformatjsonobject.ts b/src/models/responseformatjsonobject.ts index fb92f4b..409a79d 100644 --- a/src/models/responseformatjsonobject.ts +++ b/src/models/responseformatjsonobject.ts @@ -7,6 +7,16 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * JSON object response format. + * + * @remarks + * + * An older method of generating JSON responses. + * Using `json_schema` is recommended for models that support it. Note that the + * model will not generate JSON without a system or user message instructing it + * to do so. + */ export type ResponseFormatJSONObject = { type: "json_object"; }; diff --git a/src/models/responseformatjsonschema.ts b/src/models/responseformatjsonschema.ts index 43469a6..e279ed6 100644 --- a/src/models/responseformatjsonschema.ts +++ b/src/models/responseformatjsonschema.ts @@ -14,7 +14,18 @@ import { JSONSchema$outboundSchema, } from "./jsonschema.js"; +/** + * JSON Schema response format. + * + * @remarks + * + * Used to generate structured JSON responses. + * Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). + */ export type ResponseFormatJSONSchema = { + /** + * Structured Outputs configuration options, including a JSON Schema. + */ jsonSchema: JSONSchema; type: "json_schema"; }; diff --git a/src/models/responseformattext.ts b/src/models/responseformattext.ts index fde6781..c8c2c0c 100644 --- a/src/models/responseformattext.ts +++ b/src/models/responseformattext.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Default response format. Used to generate text responses. + */ export type ResponseFormatText = { type: "text"; }; diff --git a/src/models/websearchoptions.ts b/src/models/websearchoptions.ts index 280e0ed..a55a330 100644 --- a/src/models/websearchoptions.ts +++ b/src/models/websearchoptions.ts @@ -22,6 +22,12 @@ export const SearchContextSize = { } as const; export type SearchContextSize = ClosedEnum; +/** + * This tool searches the web for relevant results to use in a response. + * + * @remarks + * Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat). + */ export type WebSearchOptions = { searchContextSize?: SearchContextSize | undefined; userLocation?: WebSearchOptionsUserLocation | null | undefined; diff --git a/src/models/websearchoptionsuserlocation.ts b/src/models/websearchoptionsuserlocation.ts index fb335e9..3013a7c 100644 --- a/src/models/websearchoptionsuserlocation.ts +++ b/src/models/websearchoptionsuserlocation.ts @@ -13,7 +13,13 @@ import { WebSearchOptionsUserLocationApproximate$outboundSchema, } from "./websearchoptionsuserlocationapproximate.js"; +/** + * Approximate location parameters for the search. + */ export type WebSearchOptionsUserLocation = { + /** + * Approximate location parameters for the search. + */ approximate: WebSearchOptionsUserLocationApproximate; type: "approximate"; }; diff --git a/src/models/websearchoptionsuserlocationapproximate.ts b/src/models/websearchoptionsuserlocationapproximate.ts index d8b3d31..b5e8543 100644 --- a/src/models/websearchoptionsuserlocationapproximate.ts +++ b/src/models/websearchoptionsuserlocationapproximate.ts @@ -7,6 +7,9 @@ import { safeParse } from "../lib/schemas.js"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./errors/sdkvalidationerror.js"; +/** + * Approximate location parameters for the search. + */ export type WebSearchOptionsUserLocationApproximate = { city?: string | undefined; country?: string | undefined; diff --git a/src/sdk/languagemodels.ts b/src/sdk/languagemodels.ts index e8f024e..8f7efc4 100644 --- a/src/sdk/languagemodels.ts +++ b/src/sdk/languagemodels.ts @@ -46,6 +46,8 @@ export class LanguageModels extends ClientSDK { * * @remarks * Register a custom language model with the organization that owns the API key. + * + * The model configuration is validated by making a test API call before saving. */ async registerCustom( request: models.RegisterCustomModelRequest, @@ -99,6 +101,9 @@ export class LanguageModels extends ClientSDK { * * @remarks * Update a custom language model. + * + * If identifier, api_key, or extra are changed, the model configuration + * is validated by making a test API call before saving. */ async updateCustom( modelId: string, diff --git a/src/sdk/sdk.ts b/src/sdk/sdk.ts index 92bc740..0e459a3 100644 --- a/src/sdk/sdk.ts +++ b/src/sdk/sdk.ts @@ -90,9 +90,9 @@ export class Opper extends ClientSDK { * It is a declarative interface with input and output schemas that supports text, image, audio inputs and outputs and is highly model agnostic. */ async call( - request: models.AppApiPublicV2FunctionCallCallFunctionRequest, + request: models.CallFunctionRequest, options?: RequestOptions, - ): Promise { + ): Promise { return unwrapAsync(call( this, request, @@ -174,7 +174,7 @@ export class Opper extends ClientSDK { * ``` */ async stream( - request: models.AppApiPublicV2FunctionCallCallFunctionRequest, + request: models.CallFunctionRequest, options?: RequestOptions, ): Promise { return unwrapAsync(stream(